Page History

...

Provision of programming code for analyses, either directly in an analysis definition or via use of template programming code, is not required; sponsors may choose to include programming code to support their regulatory or operational requirements. When specified, template programming code for each analysis method is represented as an instance of AnalysisProgrammingCodeTemplate class and, in each instance:

• The context attribute

  Jira
  showSummary false server Issue Tracker (JIRA) serverId 85506ce4-3cb3-3d91-85ee-f633aaaf4a45 key ARSP-24

  is used to specify the name and version of the computer language used for the programming statements.
• The template programming statements may be provided by either:
  • storing the statements directly in the code attribute of the AnalysisProgrammingCodeTemplate class, or
  • referencing a template programming code document in the documentRef attribute of the AnalysisProgrammingCodeTemplate class (see the DocumentReference section for more information about programming code document references).

Template programming statements may contain parameter references, which could be placeholder strings for replacement parameters (e.g., "{dataset_name}", "[BYVAR1]", "<ndp>") or runtime parameter references (e.g., "&varname", "params$clsvar"). The format of parameter references in template programming code may depend on the computer language used either for the programming statements themselves or for the reading and processing ARS metadata. There are no requirements for the format of parameter references within template programming code; sponsors may use any format that facilitates their operational implementation.

• The parameters attribute

  Jira
  showSummary false server Issue Tracker (JIRA) serverId 85506ce4-3cb3-3d91-85ee-f633aaaf4a45 key ARSP-26

  may be used to specify any parameters associated with the template programming code. If parameters are specified, each parameter is specified as an instance of the TemplateCodeParameter specialization of the CodeParameter class, in which:
  • The name attribute contains a short name of the parameter.
  • The description attribute may contain a description of the parameter. If parameter references are retained in programming code that is provided as supporting metadata for analyses (e.g., as ARM for Define-XML metadata), it is recommended that a description is defined for each parameter, and that the name, description and analysis-specific value for each parameter are provided with the programming statements so that the programming statements are understandable without reference to any other documentation.
  • Either:
    • The valueSource attribute contains a reference to a metadata attribute whose value is to be used as the analysis-specific parameter value, either during a template code copying process or at the time of execution. There is currently no defined syntax for metadata attribute references; sponsors may represent metadata element references using any syntax or conventions that facilitate their operational implementation.

...