Now that the data collection API is in place and a plug-in has been written to implement it the time has come to create the data analysis API.

The data analysis API will allow plug-ins to control the analysis of data based on what data collection plug-ins are available. The data collection plug-ins themselves will be able to act as data analysis plug-ins if they choose.

By providing an API for analysis of data plug-ins can be created to display related data along side. This is more than the UTS itself should be able to do. The plug-ins will also be able to decide how data is displayed (ie. graph, table, list, picture, etc.).

What follows is a brainstorm for the API, this will be finalized through discussion and insight gained through implementation.

API
Data collection plug-ins are expected to register their own menu local tasks on the analysis page.

Analysis plug-in hooks.

  • hook_uts_data_analysis() - get analysis plug-in name, related data collection plug-in, and modes
  • hook_uts_data_display($mode)
  • hook_uts_data_export_analysis($mode)

Other than that I will see what I run into.

Comments

boombatower’s picture

boombatower commented

Currently implemented hooks.

  • hook_uts_data_analysis() - list of modes for each data collection plug-in supported by analysis plugin
  • hook_uts_data_display($module, $mode, $study_nid, $session_id = NULL, $start_timestamp = NULL, $stop_timestamp = NULL)
  • hook_uts_data_analysis_export($module, $mode, $study_nid, $session_id = NULL, $start_timestamp = NULL, $stop_timestamp = NULL)

Edit: updated.

boombatower’s picture

boombatower commented
Status: Active » Fixed

The API is not complete and is implemented in the Live text plug-in.

Anonymous’s picture

Anonymous (not verified) commented
Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.