Technical Documentation

Technical Documentation

Users can interact with a safety histogram in the following ways.

Filter by Measure

This drop-down menu is used to filter the lab variable that is displayed in the chart. The default measure is set to the first variable in the data set, but the default value can be adjusted to any measure upon the project team's request. Users can select any pre-defined measure in this filter. Selecting a measure will display the data points associated with that measure and will display the visits that the measure is collected at underneath the chart.

Filer by Baseline Visit(s)

This drop-down menu is used to filter the visit data that will be displayed in the chart. The default measure is set to 0, but the default value can be adjusted to any visit(s) upon the project team's request. Users can select one of more pre-defined visit(s) in this filter to be used as the baseline visit(s) in the chart. These values will be displayed on the x-axis.

Filter by Comparison Visit(s)

This drop-down menu is used to filter the visit data that will be displayed in the chart. The default measure is set to all visits other than visit 0, but the default value can be adjusted to any visit(s) upon the project team's request. Users can select one of more pre-defined visit(s) in this filter to be used as comparison visit(s) in the chart. These values will be displayed on the y-axis.

Filter by pre-selected characteristics

The chart can be configured to have any number of data filters. Each specified filter has a drop-down menu that is used to filter the visit data that is displayed in the chart.

Total Participants Shown

Displayed under the header, this statement provides the total number of participants in the data set in integers as well as the percentage of participants shown to one decimal place. In the default view, all participant data is included in the chart, or 100%, unless the project team requests otherwise. When filters are used, the data shown in the histogram is manipulated and the number of participant records shown at the top of the page may increase or decrease, depending on the variable selected.

Linked Table

Clicking and dragging the mouse across the data points will open a table to the right of the chart that contains a detailed listing of participant records. This linked table contains the participant's subject ID, their baseline value for the selected measure, the comparison value for the selected measure, the difference between the baseline and comparison value using an integer and a percentage. When the table appears, the data points selected will appear in a gray box inside of the chart, lightening all of the data points not selected in the box. When a user clicks outside of the gray box, the gray box disappears along with the detailed table.

Clicking and dragging the mouse over data points will perform 3 actions:

• Display the raw data records, including the subject identifier, baseline value, comparison value, change, and percent change
• Create a gray box around the selected data points
• Lighten all of the data points not contained in the table

Regression Tests

• Confirm that measure filter is working as expected
• Confirm that baseline visit filter are working as expected
• Confirm that comparison visit filter are working as expected
• Confirm that detailed record can be viewed by clicking and dragging the mouse across a section of values
• Confirm that the # of enrolled/randomized participants is visible at the top of the page
• Confirm that hovering over a data point displays subject ID, baseline value, comparison value, change value, and percent of change
• Confirm that hovering over a box and whisker marker displays the N, min, 5th percentile value, Q1, Median, Q3, 95th percentile value, max, mean, and standard deviation
• Confirm that Search works to filter the data displayed in the listing
• Confirm that Sort works in the listing by clicking on column headers
• Confirm that you can export the displayed data to a csv via via the Export: CSV button
• Confirm that unselecting data points resets the detailed record at the bottom of the page
• Confirm that the detail listing isn't initially available but then does display when the chart is brushed
• Confirm that the User can specify visit_order_col that names a variable that orders the visits.
• Confirm that Visit ordering can be set two ways: {"visit_col":"VISIT","visit_order_col":"VISITNUM"} to order visits sequentially and {"visit_col":"VISIT","visit_order_col":"VISIT"} to order visits alphanumerically.
• Confirm that the chart fits on one page.
• Confirm that the chart appears between controls and listing.
• Confirm that the listings appear to the right of the chart.
• Confirm that the controls appear to left of chart.
• Confirm that when a measure contains fewer than five unique values it isn't removed from the data (edit the dataset ADBDS so that it contains at least two results for the same measure from the same USUBJID. The shift plot is plotting the baseline value on the x-axis and the comparison value on the y-axis which requires at least two results).
• Confirm that invalid results are removed from the data rather than measures with any invalid results. Invalid results include missing and non-numeric values. Then confirm that the number of removed results is noted in the console (You can confirm by downloading the data from CAT, updating the STRESN column so a few values are bad. When you reupload the edited data you will see that the number changes appropriately in the console).