documentRef

This example shows a selection of programming code document references specified in the documentRef attribute of the codeTemplate for 1 analysis method, and the programmingCode for 1 analysis and 2 outputs:

Lines 2-7:	Show the code template specified for the "Analysis of variance group comparison for a continuous variable" analysis method, which indicates that relevant R version 4.2.3 program statements can be found in the reference document identified as "anova_R". As there is no page reference, this indicates that the whole reference document contains relevant program statements.
Lines 11-25:	Show the programming code specification for the "Comparison of Age Group by Treatment" analysis, which indicates that relevant SAS version 9.4 program statements can be found in the reference document identified as "PROGRAM_CATALOG_SAS" which, in this example, is a single file containing a combined set of programs, with a bookmark created for each program. The sponsor chose to create two separate page references in order to provide a descriptive label for each.
Lines 29-34:	Show the programming code specification for the "Summary of TEAE by System Organ Class and Preferred Term" output, which indicates that relevant SAS version 9.4 program statements can be found in the reference document identified as "at14-5-01_sas". As there is no page reference, this indicates that the whole reference document contains relevant program statements.

YAML Example

methods:
- id: Mth04_ContVar_Comp_Anova
  name: Analysis of variance group comparison for a continuous variable
  codeTemplate:
    context: R Version 4.2.3
    documentRef:
      referenceDocumentId: anova_R
  ...
...
analyses:
- id: An03_02_AgeGrp_Comp_ByTrt
  name: Comparison of Age Group by Treatment
  programmingCode:
    context: SAS Version 9.4
    documentRef:
      referenceDocumentId: PROGRAM_CATALOG_SAS
      pageRefs:
      - refType: NamedDestination
        label: Pearson chi-square macro definition
        pageNames:
        - PearsonDef
      - refType: NamedDestination
        label: Pearson macro call for age group
        pageNames:
        - PearsonCall-AgeGrp
   ...
...
outputs: 
- id: Out14-3-2-1
  name: Summary of TEAE by System Organ Class and Preferred Term
  programmingCode:
    context: SAS Version 9.4
    documentRef:
      referenceDocumentId: at14-5-01_sas
  ...
...

These programming code document references could be represented in tabular format as shown in the following table where:

The type of object for which the document reference is defined is indicated in the "object_type" column, which contains the name of the object's parent reporting event attribute.
Each instance of 1 of the specializations of the PageRef class is shown on a separate row. If there are no page references for a document reference, a single row is shown for the document reference.
Values of the id, name, and referenceDocumentId attributes is are shown on all rows relating to a document referenced for an object.
Values from the pageNames attribute have been transposed to be shown on a single row, with column names derived from the attribute name with a numeric suffix indicating the value ordinal (e.g., "pageNames1" for the first value of the pageNames attribute).

$titleHtml

object_type	id	name	context	referenceDocumentId	refType	label	pageNames1
methods	Mth04_ContVar_Comp_Anova	Analysis of variance group comparison for a continuous variable	R Version 4.2.3	anova_R
analyses	An03_02_AgeGrp_Comp_ByTrt	Comparison of Age Group by Treatment	SAS Version 9.4	PROGRAM_CATALOG_SAS	NamedDestination	Pearson chi-square macro definition	PearsonDef
analyses	An03_02_AgeGrp_Comp_ByTrt	Comparison of Age Group by Treatment	SAS Version 9.4	PROGRAM_CATALOG_SAS	NamedDestination	Pearson macro call for age group	PearsonCall-AgeGrp
outputs	Out14-3-2-1	Summary of TEAE by System Organ Class and Preferred Term	SAS Version 9.4	at14-5-01_sas

$warningHtml

Page tree

documentRef