Commits

Kathleen Tang authored f975597a7e1
DEV-19079: add notes to group and runid
No tags

files/file0009-labelfile.md

Modified
1 1 ![alt text](https://dev.sentinelsystem.org/projects/AP/repos/sentinel-analytic-packages/raw/resources/logo.png?at=refs%2Fheads%2Fmaster)
2 2
3 3 # Sentinel Routine Querying Reporting Tool
4 4
5 -## Label file
5 +## Label File
6 6
7 7 The Label File is optional and is used to customize labels of elements in the report (e.g., groups, column headers, etc.) If the Label File is not specified, default labels will be applied to all report elements.
8 8
9 9 **Table 1: LABELFILE specification**
10 10
11 11 | **Parameter** | **Field Name** | **Description** |
12 12 | --- | --- | --- |
13 -|GROUP/ANALYSISGRP/MILGRP to include in report|GROUP|Name of each cohort or analysis to include in report. <br> <br> **Note 1:** GROUP must correspond to values of COHORTGRP/ANALYSISGRP/MILGRP included in distributed input files. <br><br> **Note 2:** for Type 6 (Manufacturer-Level Product Utilization and Switching Pattern) reports, include COHORTGRP values if requesting medical product utilization tables and/or ANALYSISGRP values if requesting switching tables.<br><br> **Note 3:** if a GroupLabel is not assigned for a group, the GROUP name will be displayed. <br><br> **Note 4:** if LABELTYPE = CensorLabel, leave GROUP blank. <br><br> **Format:** SAS character $40; no special characters (e.g., commas, periods, hyphens, spaces, etc.) allowed, and underscores must be used to mark spaces. <br> **Example:** insulin|
14 -|RunID Corresponding to GROUP|RUNID|RunID assigned to the run that corresponds to the group or analysis name listed in GROUP <br> <br> **Format:** SAS character $5<br> **Example:** r01|
15 -|Type of Report Element Label Refers To|LABELTYPE|Specifies the type of report element referred to by LABEL. <br><br> Valid values are: <ul><li> **ReportTitle:** Title of Report </li><li> **BaselineLabel:** Label for L1 baseline table </li><li> **GroupLabel:** Label for GROUP </li><li> **OutcomeLabel:** Label for outcome of interest </li><li> Intervention1Label (Not yet functional): Label for intervention 1 in ITS analysis</li><li> Intervention2Label (Not yet functional): Label for intervention 2 in ITS analysis </li><li> ITSComparisonLabel (Not yet functional): Label for ITS comparison</li><li> AdherenceLabel (Not yet functional): Label for adherence criteria</li><li> MOILabel (Not yet functional): Label for medical product of interest in Type 4 report </li><li> **CensorLabel:** Label for censoring criteria <li> **CFDDCatLabel:** Label for category of current filled daily dose in Type 5 report <li> **AFDDCatLabel:** Label for category of average filled daily dose in Type 5 report <li> **CumDoseCatLabel:** Label for category of cumulative dose in Type 5 report </li><li> **Header:** Label to group multiple GROUPs under a single header </li></ul> **Note 1:** if >1 GROUP is included in 1 baseline table (using BASELINEGROUPNUM parameter in Baseline File), then the LABEL value for LABELTYPE = BaselineLabel should be the same for the two GROUPs appearing on the same table. Otherwise the program will default to LABEL value for the first GROUP listed. <br><br>**Note 2:** if LABELTYPE = AdherenceLabel, MOILabel, CensorLabel, CFDDCatLabel, AFDDCatLabel, or CumDoseCatLabel, then LABELVAR must be specified. <br><br> **Note 3:** if no Header label is specified, all GROUPs will be displayed together with no header. <br><br> **Note 4:** if LABELTYPE = ReportTitle, GROUP and RUNID should be left blank. If ReportTitle is not defined, the default label "Exposures of Interest" will be used. <br><br> **Format:** SAS character $30 <br> **Example:** ReportTitle|
13 +|GROUP/ANALYSISGRP/MILGRP to include in report|GROUP|Name of each cohort or analysis to include in report. <br> <br> **Note 1:** GROUP must correspond to values of COHORTGRP/ANALYSISGRP/MILGRP included in distributed input files. <br><br> **Note 2:** for Type 6 (Manufacturer-Level Product Utilization and Switching Pattern) reports, include COHORTGRP values if requesting medical product utilization tables and/or ANALYSISGRP values if requesting switching tables.<br><br> **Note 3:** if a GroupLabel is not assigned for a group, the GROUP name will be displayed. <br><br> **Note 4:** if LABELTYPE = CensorLabel or ReportTitle, leave GROUP blank. <br><br> **Format:** SAS character $40; no special characters (e.g., commas, periods, hyphens, spaces, etc.) allowed, and underscores must be used to mark spaces. <br> **Example:** insulin|
14 +|RunID Corresponding to GROUP|RUNID|RunID assigned to the run that corresponds to the group or analysis name listed in GROUP <br> <br> **Note 1:** if LABELTYPE = ReportTitle, leave RUNID blank. <br><br> **Format:** SAS character $5<br> **Example:** r01|
15 +|Type of Label|LABELTYPE|Specifies the type of report element referred to by LABEL. <br><br> Valid values are: <ul><li> **ReportTitle:** Title of Report </li><li> **BaselineLabel:** Label for L1 baseline table </li><li> **GroupLabel:** Label for GROUP </li><li> **OutcomeLabel:** Label for outcome of interest </li><li> Intervention1Label (Not yet functional): Label for intervention 1 in ITS analysis</li><li> Intervention2Label (Not yet functional): Label for intervention 2 in ITS analysis </li><li> ITSComparisonLabel (Not yet functional): Label for ITS comparison</li><li> AdherenceLabel (Not yet functional): Label for adherence criteria</li><li> MOILabel (Not yet functional): Label for medical product of interest in Type 4 report </li><li> **CensorLabel:** Label for censoring criteria <li> **CFDDCatLabel:** Label for category of current filled daily dose in Type 5 report <li> **AFDDCatLabel:** Label for category of average filled daily dose in Type 5 report <li> **CumDoseCatLabel:** Label for category of cumulative dose in Type 5 report </li><li> **Header:** Label to group multiple GROUPs under a single header </li></ul> **Note 1:** if >1 GROUP is included in 1 baseline table (using BASELINEGROUPNUM parameter in Baseline File), then the LABEL value for LABELTYPE = BaselineLabel should be the same for the two GROUPs appearing on the same table. Otherwise the program will default to LABEL value for the first GROUP listed. <br><br>**Note 2:** if LABELTYPE = AdherenceLabel, MOILabel, CensorLabel, CFDDCatLabel, AFDDCatLabel, or CumDoseCatLabel, then LABELVAR must be specified. <br><br> **Note 3:** if no Header label is specified, all GROUPs will be displayed together with no header. <br><br> **Note 4:** if LABELTYPE = ReportTitle, GROUP and RUNID should be left blank. If ReportTitle is not defined, the default label "Exposures of Interest" will be used. <br><br> **Format:** SAS character $30 <br> **Example:** ReportTitle|
16 16 |Variable to Relabel|LABELVAR|Specifies the variable referred to by LABEL. <br><br> Valid values are: <br> <br> <u> If LABELTYPE = CensorLabel: </u> <ul><li> **cens_elig:** Disenrollment <li> **cens_dth:** Evidence of death <li> **cens_dpend:** DP data end date <li> **cens_qryend:** Query end date <li> **cens_episend:** Episode end date <li> **cens_spec:** Additional user-specified criteria <li> **cens_event:** Occurrence of request-defined event <li> **cens_switch1:** First switch in type 6 analysis <li> **cens_switch2:** Second switch in type 6 analysis </ul></li><br> <u> If LABELTYPE = CFDDCatLabel, AFDDCatLabel, or CumDoseCatLabel: </u> <ul><li> **dosecat#:** # corresponds to dose category number in Type 5 analysis </ul></li><br> **Format:** SAS character $32 <br> **Example:** cens_spec|
17 17 |Label to Apply|LABEL|Label (display name) for report element specified in LABELTYPE. <br> <br> **Format:** SAS character - length can vary <br> **Example:** Beta Blockers|
18 18
19 19
20 20 <br>
21 21 <br>

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut