Skip to content

Technical Documentation

emmorris edited this page Oct 26, 2017 · 26 revisions

User Requirements

Users can:

  • See the timeline for an overview of clinical events
  • See points for events occurring on a single day
  • See lines for events that occur over multiple days
  • View a legend that identifies the marks (points and lines) used in the chart
  • See the number and percentage of row identifiers displayed in the current view (updates with each user interaction)
  • Toggle the x-axis to display different time measures (e.g. study day, visit, or visit number)
  • Group items on the y-axis using a preselected variable
  • Change the input on the site filter and see an updated chart
  • Change the input on the row identifier filter and see an updated chart
  • Change the input on the event type filter and see an updated chart
  • Sort row identifiers by earliest event or alphanumerically and see an updated chart
  • Display metadata by hovering over a mark
  • Click on a y-axis tick label to see a detailed view of the clinical events and the underlying data of that row identifier
  • Search the data listing
  • Sort the data listing
  • Navigate the data listing via pagination controls
  • Export the data listing to a .csv file
  • Navigate from the detailed view back to the main page

Functional Specifications

Population Statistics

Displayed in the top left corner of the page, this statement describes the number of currently selected row identifiers, the total number of row identifiers, and the corresponding sample/population rate formatted as a percentage to one decimal place. Initially all events are visible in the chart and the sample/population rate is set to the number of row identifiers with any event divided by the total number of row identifiers, unless the project team requests otherwise. Filters affect the sample count and the population statistics are updated accordingly.

Filter by Participant ID

This drop-down lists all row identifiers included in the data. Selecting a specific row identifier displays a more detailed view of events experienced by that row identifier. This filter defaults to 'All'.

Filter by Event Type

This menu is used to filter on various clinical events in the data set. The default is set to include all events, but users can select one or more events using CTRL + click. Each event type corresponds to a colored dot in the legend above the chart. Selecting an event type will display data that corresponds with the appropriate colored event, so events can be viewed in the timeline at a glance.

Filter by Site

This drop-down lists all the sites included in the data. The default is set to include all sites, but users can select a specific site to subset the data and alter the chart.

Sort by Subject IDs

This toggle can sort the participant IDs included in the data set. This option can sort the data by the participants with the earliest occurring clinical event(s) or the participants that appear first alphabetically in descending order. This option defaults to the earliest occurring clinical events and their related participants.

Hover

By moving a mouse cursor over an event in the chart, users can display metadata for some variables. Hovering the cursor over a particular point will display the name of the event, the day the event started, and the day the event stopped. More information about the event can be accessed by clicking on the participant ID to the left of the chart or filtering on the ID.

Detailed View

Hovering the cursor over a particular data point will display some data, but clicking on the participant ID to the left of the chart or filtering on participant ID will load a more detailed view of all events. This view displays an individual clinical timeline for the participant and the raw data for a participant's clinical events. When initiated, the top right corner of the page will list the participant ID that the user is viewing.

Individual Subject Timeline

The individual subject timeline shows all of the clinical events for a single participant in a timeline graphic. This display shows events broken out by type and includes the same information displayed on hover. The filtering options for participant and event type can also be used in this view. If a combination of participant and event type is selected that returns no results, then a message stating 'No data selected.' is displayed.

Data Table

The detailed view shows the raw data for each event associated with a single participant. This data is listed in a table and it shows the event name, sequence number for the event, the day the event started, the day the event stopped, the participant's id, and the site associated with the event. If the data doesn't fit on the initial page, then pagination options appear at the bottom right corner.

Search box

The detailed view allows the user to search for a specific term to locate it in the data. To initiate this feature, users can type text into the box and the entry automatically searches through the data listing and displays results with matching text. The number of records displayed is shown to the right of the search box. To return to the default data display, the user can click in the search box and delete the entered text.

Sort using Column Header

Users can click on a column header and sort the data within a column in ascending and descending order. The first time a user clicks the column header, the column is sorted in ascending order and a box appears above the data listing containing the variable name that has been selected and an arrow indicating the direction of the ordered data. When a user clicks the column header a second time, the data will be sorted in descending order and the direction of the arrow in the box above the data listing will change to match the new sort. Clicking on the red 'x' within the box containing the variable name both removes the sorting and closes the box.

Export Data

Users can download the data as a CSV by clicking on the 'CSV' button located underneath the chart within the detailed view. The CSV file will contain all of the data if no filters have been utilized. If filters have been used, the CSV file will contain the resulting data. The file will also capture any sorting that has been initialized in the data. The CSV download will be named using the following convention: webchartsTableExport, date, and time.

Return to the Clinical Timeline

The 'Back' button is only visible if users have clicked on the detailed view for a given participant. Clicking on this button returns users to the default Clinical Timelines view.

Clone this wiki locally