5 Figure File Parameters
The Figure File lookup tables are used to specify which figures to produce for the output in the report. Lookup tables differ by report type. All lookup tables can be found in the Reporting Tool templatefiles folder. The user will download the Reporting Tool, select the appropriate Figure lookup tables for their request type, and edit the relevant parameters directly in the lookup table.
The Figure File is optional and is used to specify which figures and corresponding stratifications to produce for the report output and to customize the figure. Table 5.1 contains links to Figure File lookup tables for each type of analysis. Table 5.2 contains detailed specifications for the Figure File.
Analysis Type | Figure File Lookup |
---|---|
Descriptive Type 1 | Type 1 Figure File Lookup Table |
Descriptive Type 2 | Type 2 Level 1 Figure File Lookup Table |
Inferential Type 2 | Type 2 Level 2 Figure File Lookup Table |
Descriptive Type 4 | N/A |
Inferential Type 4 | Type 4 Level 2 Figure File Lookup Table |
Descriptive Type 5 | Type 5 Figure File Lookup Table |
Descriptive Type 6 | Type 6 Figure File Lookup Table |
Interrupted Time Series (ITS) | ITS Figure File Lookup Table28 |
Parameter | Field Name | Description |
---|---|---|
Figure | FIGURE | Figure identifier. User should not edit. |
Dataset | DATASET | QRP output dataset identifier. User should not edit. |
Figure Stratification | FIGURESUB | Figure stratification identifier. User should not edit. |
Level | LEVELNUM | Specifies the number of level ID variables required in order to produce the figure. For example, if LEVELNUM = 1, then the output defined in LEVELID1 is required to be included in the distributed results, but the output defined in LEVELID2 and LEVELID3 is optional and not necessary to output the figure. User should not edit. |
Level 1 ID | LEVELID1 | First level identifier. User should not edit. |
Level 2 ID | LEVELID2 | Second level identifier. User should not edit. |
Level 3 ID | LEVELID3 | Third level identifier. User should not edit. |
Include in Report | INCLUDEINREPORT | User specifies whether to output the corresponding figure in the report. |
Valid values are:
|
||
Format: SAS character $1 | ||
Example: Y | ||
Minimum X-Axis Value | XMIN | The user can optionally specify the minimum x-axis on the Cumulative Distribution Function (CDF), Kaplan-Meier (KM), or Cumulative Incidence Function (CIF) plot. |
Note 1: the default minimum x-axis value is 0. | ||
Format: Numeric | ||
Example: 50 | ||
Maximum X-Axis Value | XMAX | The user can optionally specify the maximum x-axis on the CDF, KM, or CIF plot. |
Note 1: the default maximum x-axis value is the maximum of the data. | ||
Format: Numeric | ||
Example: 100 | ||
X-Axis Tick Marks | XTICK | The user can optionally specify the distance between x-axis tick marks on the CDF, KM, or CIF plot. |
Note 1: by default there will be 6 x-axis tick marks; the code will determine the tick values. | ||
Note 2: if XMIN = 0, XMAX = 200, and XTICK = 50, this will create x-axis tick values of 0, 50, 100, 150, and 200. | ||
Format: Numeric | ||
Example: 20 | ||
Minimum Y-Axis Value | YMIN | The user can optionally specify the minimum y-axis on the CDF, KM, or CIF plot. |
Note 1: the default minimum y-axis value is 0. | ||
Format: Numeric | ||
Example: 0.80 | ||
Maximum Y-Axis Value | YMAX | The user can optionally specify the maximum y-axis on the CDF, KM, or CIF plot. |
Note 1: the default maximum y-axis value is 1. | ||
Format: Numeric | ||
Example: 0.90 | ||
Y-Axis Tick Marks | YTICK | The user can optionally specify the distance between y-axis tick marks on the CDF, KM, or CIF plot. |
Note 1: the default y-axis tick value is 0.2. | ||
Note 2: if YMIN = 0.5, YMAX = 1, and YTICK = 0.1, this will create y-axis tick values of 0.5, 0.6, 0.7, 0.8, 0.9, and 1. | ||
Format: Numeric | ||
Example: 0.5 | ||
Censoring Criteria to Display | CENSORDISPLAY | User lists censoring criteria to display on the CDF, KM, or CIF plot, separated by a space. |
Valid values are:
|
||
Note 1: if left blank, all censoring criteria relevant to the figure will be displayed. | ||
Note 2: for Type 6 CIF plots (figures F8 and F9), user can specify only one of any of the following values: cens_episend, cens_dth, cens_elig, cens_dpend and cens_qryend, to be used as a competing risk. cens_switch is not a valid value for competing risk in Type 6 analyses. | ||
Format: SAS character - length can vary | ||
Example: cens_elig cens_dth cens_dpend cens_event | ||
Include At-Risk Table | INCLUDEATRISKTABLE | User specifies whether to output at-risk table below censoring figure. |
Valid values are:
|
||
Format: SAS character $1 | ||
Example: N |
Not yet functional↩︎