The usage of the plugin is quite simple. Just log into the i2b2 webclient, choose Analysis Tools and choose Additional Data from the list of plugins. The following plugin screen should appear:
Using the now displayed Options tab it is possible to decide for a number of persistent options. However, these options can also be changed while data is displayed. In this case, the button Refresh Current Tabs must be pressed. This function of the options will now explained shortly.
Allow the use of math and logical operators in search fields
If this option is enabled it is not only possible to filter table columns using matching character sequences. It is also possible to use the mathematical operators >, >=, <, <= in columns that contain only numbers to filter for specific numerical ranges.
Also in all columns = can be used to find an absolute match to the search term. [empty] can be used to find empty cells and [filled] can be used to find filled cells.
Additionally && can be used to combine two different conditions using the logical AND statement. Similarly || can be used to combine two different conditions using the logical OR statement.
Hide patients tabs where they do not feature any symptom
This will hide patients in specific modifier tabs if they do not feature any of the concepts shown in this tab.
Display exact symptom (default) or "exists" for observations without a value
There may exist concepts in your database that only define that a patient has a specific symptom without having any values for this concept. This option sets if instead of a value, the specific concept name should be displayed in the cell, or if only an existing text should be shown.
Show the mapped (default) or hive patient id
This option set if the unique but more database bounded hive id should be displayed in the patient id column or if the particular mapped id of the patient should be displayed.
Color numerical columns based on their average value
If this feature is enabled numerical cells will be tinted based on the average numerical value in the column. Values near to the average will be tinted green, values far from the average will be tinted red.
Display summary tab (combining all other tabs)
If this option is enabled a summary tab will be created combing all information of all other tabs. Keep in mind that this tab tends to be huge.
Reduce the maximal text size in any table cell to 20 characters.
This option is only used to allow a fast overview of the data. It will simply cut text in cells after they have reached a length of 20 characters.
Now, to get additional information about the an previous query just drag and drop a query from the list of Previous Queries onto the big region with the text Drop The Patient Set Here. After this was done, the retrieval of the information may take a while. When finishing, this tabular overview will be shown, in this example case for a query that have queried all male patients of any age, who are smokers once a day or once a week and have biomaterial left in the freezers.
The top row shows three tabs: Patient Data, IDRT-CSV-Biomaterial and Summary. The patient data tab will always display data directly related to the patient. All other tabs will display data related to a modifier which is related to the patient. In this case we have required a biomaterial modifier, namely the Amount Left. It is recognizable, that multiple biomaterials for the same patients were found. As in general, no linkage between multiple modifiers for one patient can be made; all occurrences will be shown independent. The Summary Tab will finally combine all other tabs to one single tabular overview.
Now, by clicking on one of the table headers, the table can be sorted ascending or descending using this column. Per default the table is sorted by ascending patient ids. The input fields below the table headers can be used to filter the contents of the table using the syntax elucidated earlier. Multiple filters can be active at once.
Furthermore, by clicking on the floppy symbol of the currently active tab or by right clicking on the table a context menu will be shown. This offers the possibility to export the current table as a CSV. If the menu is used on the summary tab, there will also be options to hide or unhide specific modifiers from the summary tab. Additionally, the option exists to unhide all hidden modifiers at once.
Finally, at any time a new query can be loaded by dragging another query from the Previous Query list and dropping it on the topmost region saying You Can Still Drop Another Query Here.