Sentinel Routine Querying Tool Report Documentation
Public
Commits
Andrew Simon authored 202949e6bba
| 29 29 | |Logo File|LOGO|Name of the file (including extension) for logo to display in report. <br><br> **Note 1:** to ensure correct formatting, logo should be a JPG. <br><br> **Note 2:** if left blank, no logo will be displayed. <br><br> **Example:** Sentinel_logo.jpg| |
| 30 30 | |Highlight Small Cells Indicator|SMALL_CELLCOUNTS|Y/N indicator to highlight small cells in the report. Cell counts in the report with values between 1 and 10 will be highlighted yellow if “Y” is specified. <br><br> Valid values are: <ul> <li> **Y:** Highlight small cells <li> **N:** Do not highlight small cells </li> </ul> <br> **Note 1:** SMALL_CELLCOUNTS cannot be left blank. <br><br> **Example:** Y| |
| 31 31 | |Query Period Start Identifier|LOOK_START|Identifies at what period ID, as specified in the Monitoring file, the report should begin outputting results. <br><br> **Note 1:** LOOK_START cannot be left blank. <br><br> **Example:** 1| |
| 32 32 | |Query Period End Identifier|LOOK_END|Identifies at what period ID, as specified in the Monitoring file, the report should end outputting results. <br><br> **Note 1:** LOOK_END cannot be left blank. <br><br> **Example:** 1| |
| 33 33 | |Redact Events, Rates, and Risk Estimates Indicator|REDACTEVENTS|Character indicator specifying whether to suppress Kaplan-Meier (KM) curves and redact the following from the output effect estimate tables: <ul> <li> Number of events <li> Incidence rate per 1000 person years <li> Incidence rate difference per 1000 person years <li> Risk per 1,000 users <li> Risk difference per 1,000 users <li> Hazard ratios and CIs </li> </ul> <br> Valid values are: <ul> <li> **0:** no redaction <li> **1:** redact all columns <li> **2:** redact all columns except number of events. Number of events displayed as summed across both comparator groups. </li> </ul> <br> **Note 1:** REDACTEVENTS cannot be left blank when REPORTTYPE = T2L2 or T4L2. <br><br> **Note 2:** only relevant for REPORTTYPE = T2L2 and T4L2. <br><br> **Example:** 0| |
| 34 34 | |Redact Person-Time Indicator|REDACTPT|Character indicator specifying whether to redact the following from the output effect estimate tables: <ul> <li> Person years at risk <li> Average person days at risk <li> Average person years at risk </li> </ul> <br> Valid values are: <ul> <li> **0:** no redaction <li> **1:** redact all columns </li> </ul> <br> **Note 1:** REDACTPT cannot be left blank when REPORTTYPE = T2L2. <br><br> **Note 2:** only relevant for REPORTTYPE = T2L2. <br><br> **Example:** 0| |
| 35 35 | |Data Partner Information File|DPINFOFILE|Name of the SAS dataset listing Data Partners to include in report. <br><br> **Example:** report_dp_info| |
| 36 36 | |L2 Comparisons File|L2COMPARISONSFILE|Name of the SAS dataset containing list of comparisons and parameters related to each comparison for L2 reports. <br><br> **Note 1:** L2COMPARISONSFILE cannot be left blank when REPORTTYPE = T2L2 or T4L2. <br><br> **Note 2:** only relevant for REPORTTYPE = T2L2 and T4L2. <br><br> **Example:** report_l2comparisons| |
| 37 37 | |Groups File|GROUPSFILE|Name of the SAS dataset containing list of groups and parameters related to each group for L1 reports. <br><br> **Note 1:** GROUPSFILE cannot be left blank when REPORTTYPE = T1, T2L1, T4L1, T5, and T6. <br><br> **Note 2:** only relevant for REPORTTYPE = T1, T2L1, T4L1, T5, and T6. <br><br> **Example:** report_groups_info| |
| 38 38 | |Baseline Tables File|BASELINEFILE|Name of the SAS dataset containing options for baseline tables. <br><br> **Note 1:** if BASELINEFILE is missing, no baseline tables will be produced. <br><br> **Example:** report_baseline| |
| 39 - | |Table Parameters File|TABLEFILE|Name of the SAS dataset containing all tables to produce. User specifies the INCLUDEINREPORT parameter in the Table File to request the table. Specifications for the Table File vary depending on the study type and are described in the Lookup Tables section of the documentation. <br><br> **Note 1:** if TABLEFILE is missing, then only baseline tables will be produced, if specified. <br><br> **Example:** report_figures| |
| 39 + | |Table Parameters File|TABLEFILE|Name of the SAS dataset containing all tables to produce. User specifies the INCLUDEINREPORT parameter in the Table File to request the table. Specifications for the Table File vary depending on the study type and are described in the Lookup Tables section of the documentation. <br><br> **Note 1:** if TABLEFILE is missing, then only baseline tables will be produced, if specified. <br><br> **Example:** report_tables| |
| 40 40 | |Figure Parameters File|FIGUREFILE|Name of the SAS dataset containing all figures to produce. User specifies the INCLUDEINREPORT parameter in the Figure File to request the figure. Specifications for Figure File vary depending on the study type and are described in the Lookup Tables section of the documentation. <br><br> **Note 1:** if FIGUREFILE is missing, then no figures will be produced. <br><br> **Example:** report_figures| |
| 41 41 | |Label Parameters File|LABELFILE|Name of the SAS dataset containing all labels to be used in the report. <br><br> **Note 1:** if LABELFILE is missing, then the parameter name in the distributed input files will be used. <br><br> **Example:** report_labels| |
| 42 42 | |ITS Regression File|ITSREGRESSION|Name of the SAS dataset containing the parameters for an Interrupted Time Series analysis. <br><br> **Note 1:** ITSREGRESSIONFILE cannot be left blank when REPORTTYPE = ITS. <br><br> **Note 2:** only relevant for REPORTTYPE = ITS. <br><br> **Example:** report_itsregression| |
| 43 43 | |Tree Aggregation File|TREEAGGFILE|Name of the SAS dataset containing tree aggregation parameters for Signal Identification analysis. <br><br> **Note 1:** TREEAGGFILE cannot be left blank when REPORTTYPE = T2Tree, T3Tree, or T4Tree. <br><br> **Note 2:** only relevant for REPORTTYPE = T2Tree, T3Tree, T4Tree, T2L2, and T4L2. <br><br> **Example:** report_treeagg| |
| 44 44 | |Appendix File|APPENDIXFILE|Name of the lookup table defining report appendices. <br><br> **Note 1:** if APPENDIXFILE is missing, then report appendices will not be output.<br><br> **Example:** report_appendix| |
| 45 45 | |Selection Probabilities File|SELECTIONPROBABILITIES|Name of the lookup table defining selection probabilities for each analysis and subgroup. <br><br> **Note 1:** if SELECTIONPROBABILITIES is missing, then selection probabilities will not be included in the effect estimate tables. <br><br> **Note 2:** only relevant for REPORTTYPE = T4L2. <br><br> **Example:** report_selection_prob| |
| 46 46 | |Code Descriptions File|CODEDESCRIPTIONSFILE|Name of the lookup table to map code to code description for Code Distribution output table. <br><br> **Note 1:** if CODEDESCRIPTIONSFILE is missing, then code descriptions will be missing. <br><br> **Note 2:** only relevant for OUTPUTCODEDISTRIBUTION = Y. <br><br> **Example:** report_codedescriptions| |
| 47 47 | |Table Columns File|TABLECOLUMNSFILE|Name of lookup table defining all columns and defaults to include in report tables. Optional table to exclude columns, rename columns, change the order, and include custom columns. <br><br> **Note 1:** if TABLECOLUMNSFILE is missing, then default columns will be output. <br><br> **Note 2:** only relevant for REPORTTYPE = T1, T2L1, and T4L1. <br><br> **Example:** report_columns_info| |
| 48 48 | |
| 49 49 | |