Skip to content

Technical Documentation

Dane Dexheimer edited this page Sep 19, 2019 · 28 revisions

Regression Tests

Legend

  • Confirm a legend appears in the top left labeled Visit Status with one legend item per visit status.
  • Confirm visit statuses flagged in the data by the plot_exclude column do not appear in the visit status legend.
  • Confirm the visit status legend info icons (ⓘ) have tooltips that match the contents of the visit_status_description column in the data.
  • The info icon tooltips of expected/overdue visit statuses in the Visit Status legend should describe the visual appearance of expected/overdue visits in the charts
  • Verify # of participants appears in the same place in both Charts and Listing. It should be in the right corner below the filter drop downs and above the charts/listing.

Filters

  • Confirm the controls section contains Site, Participant Status, Analysis Subset 1, Analysis Subset 2, Analysis Subset 3, and # of Overdue Visits_ filters.
  • Confirm the Participant Status dropdown allows zero or more selections.
  • Confirm the Analysis Subset 2 subsets the set of visits presented in the listing and charts.
  • Confirm the listing and charts react as expected when filters change.
  • Verify that the # of Overdue Visits dropdown updates the subset of participants as expected. For example, set the dropdown to 2 and verify that those participants actually have two overdue visits (you may need to view the Study Day Chart/Schedule of Events by Study Day to confirm).
  • Verify the >1 Overdue Visits dropdown no longer appears
  • Verify The # of Overdue Visits dropdown is present, and appears before the Analysis Subsetter filters
  • Confirm that the minimum option for # of Overdue Visits dropdown is 0. It can have more but at least 0 must be present.
  • Specify a nonexistent filter variable in the Custom Filter Variables field. No filter representing that variable should appear and the webpage should render as expected.
  • Confirm when changing filters, if there is any loading time and you move the cursor, the mouse cursor changes to the spinning circle icon.
  • Verify that four options are visible in the Participant Status dropdown
  • Verify the reset button is present and working:
    • Verify the reset button is disabled initially.
    • Change one or more filter dropdowns.
    • Verify the reset button becomes clickable.
    • Verify the displays update as expected.
    • Click the reset button.
    • Verify the filter dropdowns reset.
    • Verify the displays update as expected

Tabs/Legends

  • In CAT under the settings options, switch Chart layout to side by side and render the the chart. Confirm that clicking the Charts tab hides the listing, displays the charts, removes the Listing tab highlighting, and highlights the Charts tab.
  • Confirm that depending on which tab the user is on, the corresponding three animated balls should appear when the user changes any controls or switches tabs, and the mouse cursor changes to the spinning circle icon.
  • Confirm the three animated balls should disappear as soon as the view is updated
  • Confirm that a mark legend appears in the same container as the chart tabs.
  • Confirm when the Visit Chart is active, the legend displays rectangles corresponding to the visit statuses represented by that mark (i.e. solid rectangles represent Completed/Missed and rectangles with a dot in them represent Expected/Overdue).
  • Confirm when the Study Day Chart is active, the legend displays circles corresponding to the visit statuses represented by that mark.
  • Confirm when the Listing is active there is no legend displayed.
  • Download the visits data file and add additional statuses to the visit_status column, e.g. completador, expectadador, overduedeador, missedodor, etc. Really whatever you can think of.
  • Upload the data file, render the chart with it, and verify that the statuses in the visit expectation legend are all delimited with forward slashes.

Listing

  • Confirm when loading the listing, three animated balls appear underneath of the Listing tab
  • Confirm when loading the charts, three animated balls appear underneath of the Charts tab
  • Confirm that a checkbox labeled "Display visit dates" displays in the top left of the listing container.
  • Confirm that when Display visit dates is unchecked, any past visits shown in the listing display the visit status. (Completed, Missed, etc.) and any future visits display the visit date.
  • Confirm that when Display visit dates is checked, all visits display the visit date.
  • Confirm the Site, ID and Status columns sort alphabetically and the remaining columns sort chronologically
  • Confirm a div appears above the table containing the text of the clicked column, an arrow indicating sort direction, and an X.
  • Confirm clicking the div removes that column from the sort order.
  • Confirm hovering over visit column headers reveals a breakdown of visit statuses for that visit.
  • Confirm hovering over any table body row displays a black border underneath that row.
  • Confirm hovering over a participant ID cell reveals a breakdown of visit status for that participant ID.
  • Confirm each and every visit cell tooltip contains participant ID, visit, visit date, and visit status.
  • Confirm one or more export buttons appear at the bottom of the chart: CSV; XLSX if one of the xlsx or xlsx-style libraries is loaded; and PDF if the jspdf and jspdf-autotable libraries are loaded (PDF is still experimental, ignore this for now, per Spencer).
  • Confirm upon clicking an export button a file of the selected format downloads and contains a table with the same structure as the listing.
  • Confirm that a scrollbar appears above the listing (might have to zoom in), and that scrolling the top scrollbar scrolls the bottom scrollbar and vice versa.
  • Verify the heat map feature in listing has been removed and only display text

Charts

  • Confirm the settings form in CAT should load controls for each setting.
  • Confirm a chart with participant on the y-axis and visit on the x-axis appears in the Visit Chart tab
  • Confirm that in the Visit Chart tab, you can set abbreviate_visits to true, and the x-axis labels show abbreviated display values. All tooltips should show the full visit name when you hover over the abbreviated labels or any cell in the chart.
  • Confirm that setting abbreviate_visits to false changes the x-axis labels to again show the full visit name.
  • Confirm a chart with participant on the y-axis and study day on the x-axis appears in the Study Day Charts tab
  • Confirm completed/missed visits do not have a white circle in their center, i.e. are solid.
  • Confirm expected/overdue visits have a white circle in their center.
  • Confirm visit values are rotated by 45° in the Schedule of Events by Visit chart both at the top of the chart and at the bottom.
  • Verify the Visit Chart presents a color-coded grid with visit on the x-axis and participant on the y-axis
  • Confirm unscheduled/early termination visits appear only in the Schedule of Events by Study Day chart.
  • Confirm unscheduled/early termination visits are annotated in the Schedule of Events by Study Day chart with the first character of the visit value, e.g. U for Unscheduled Visit or E for Early Termination Visit.
  • Confirm that when scrolling in the Visit Chart and in the Study Day Chart, the top x-axis stays in view at the top of the screen.
  • Confirm Charts should be rendered on separate tabs when chart_layout = 'tabbed'. (When the layout is tabbed, you'll also need to make sure "active_tab" setting is set to 'Visit Chart' or 'Study Day Chart')
  • Confirm Charts should be rendered on the same tab when chart_layout = 'side-by-side'. (When the layout is side-by-side, you'll also need to make sure "active_tab" setting is set to 'Charts' or 'Listing')
  • Confirm that when mousing over the Visit Chart, the x- and y-axis tick labels corresponding to the visit and participant of the cell underneath the mouse embolden.
  • Confirm that when mousing over the Study Day Chart, the y-axis tick label corresponding to the participant of the row underneath the mouse emboldens, and that an x-axis tick label appears corresponding to the study day of the x-position of the mouse.
  • Confirm that when you click a mark in the Study Day Chart, an annotation appears between the top x-axis and the chart that displays the selected visit name and the median study day of that visit.
  • Confirm that with the mark still clicked in Study Day Chart, a vertical reference line appears corresponding to the median study day of that visit.
  • Confirm that with the mark still clicked in Study Day Chart, the annotation and vertical reference line both have tooltips that list the visit name, the median study day, summary statistics of the study day of that visit (n, min, median, max, mean, standard deviation), and an instruction detailing how to remove highlighting.
  • Confirm that with the mark still clicked in Study Day Chart, all marks representing that visit are highlighted.
  • Confirm that with the mark still clicked in Study Day Chart, horizontal reference lines appear connecting the visit marks to the vertical reference line.
  • Confirm that with the mark still clicked in Study Day Chart, the horizontal reference lines have tooltips that list the number of days between that mark and the median reference study day, as well as an instruction detailing how to remove highlighting.
  • Confirm that with the mark still clicked in Study Day Chart, any marks representing a different visit are faded.
  • Confirm that with the mark still clicked in Study Day Chart, the reference line is redrawn at the same timepoint when a filter is changed. The reference day should not change when filters change, and the line should always be set to the height of the chart.
  • Confirm that with the mark still clicked in Study Day Chart, clicking the annotation, the vertical reference line, the horizontal reference lines, or any highlighted mark removes all highlighting.
  • Confirm that the X-axis tick label tooltips in visit chart match the column header tooltips in listing (i.e. they should display the visit and a breakdown of visit statuses at that visit).
  • Verify that points are not cut off on the edges of the chart canvas in the Study Day Chart.

Misc

Clone this wiki locally