Module CRT-DDS V1.0 (Run Time)

Overview

This is the CDISC CRT-DDS 1.0 run-time macro library.
Module CRT-DDS V1.0 (Run Time) Macro Summary
Exposure
Macro
%crtdds_clitemdecodetrans(_cstsourcestudy=, _cstsourcecolumns=, _cstcodelistitemsds=, _cstmdvDS=, _cststudyds=, _cstcodelistsds=, _cstCLlang=, _cstoutclitemdecodetransds=);
%crtdds_codelistitems(_cstsourcecolumns=, _cstcodelistsds=, _cstoutcodelistitemsds=);
%crtdds_codelists(_cstsourcecolumns=, _cstmdvds=, _cstmdvname=, _cstoutcodelistsds=);
%crtdds_computationmethods(_cstsourcecolumns=, _cstsourcestudy=, _cstmdvds=, _cstitemdefsds=, _cststudyds=, _cstoutcomputationmethodsds=);
%crtdds_definedocument(_cstname=, _cstdescr=, _cstoutdefinedocds=);
%crtdds_getStatic(_cstName=, _cstVar=);
%crtdds_itemdefs(_cstsourcecolumns=, _cstsourcestudy=, _cststudyds=, _cstmdvds=, _cstcodelistsDS=, _cstoutitemdefsds=, _cstoutitemdefsds2=);
%crtdds_itemgroupdefitemrefs(_cstsourcecolumns=, _cstsourcetables=, _cstsourcestudy=, _cstitemdefsds2=, _cstmdvds=, _cstitemgroupdefsds=, _cststudyds=, _cstoutitemgroupdefitemrefsds=);
%crtdds_itemgroupdefs(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupdefsds=);
%crtdds_itemgroupleaf(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupleafds=);
%crtdds_itemgroupleaftitles(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupleaftitlesds=);
%crtdds_metadataversion(_cstname=, _cstdescr=, _cststandard=, _cstversion=, _cstdefineversion=, _cststudyds=, _cststudyname=, _cstoutmdvds=);
External
CRTDDS
%crtdds_read;
External
CRTDDS
%crtdds_sdtm311todefine10(_cstOutLib=, _cstSourceTables=, _cstSourceColumns=, _cstSourceStudy=);
%crtdds_study(_cstname=, _cstdescr=, _cstprotocol=, _cstdefineds=, _cstdefinename=, _cstoutstudyds=);
External
CRTDDS
Validation
Process
%crtdds_validate /des='CST: Validate CDISC CRTDDS model files';
External
CRT-DDS
%crtdds_write(_cstCreateDisplayStyleSheet=1, _cstOutputEncoding=, _cstHeaderComment=, _cstResultsOverrideDS=, _cstLogLevel=info);
External
CRTDDS
%crtdds_xmlvalidate(_cstLogLevel=info, _cstResultsOverrideDS=);
Internal
Framework Utility
%crtddsutil_buildchecktablelist(_cstCheckDS=, _cstWhereClause=, _cstOutputDS=);

Macro Detail

%crtdds_clitemdecodetrans

%crtdds_clitemdecodetrans(_cstsourcestudy=, _cstsourcecolumns=, _cstcodelistitemsds=, _cstmdvDS=, _cststudyds=, _cstcodelistsds=, _cstCLlang=, _cstoutclitemdecodetransds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcestudy
  • _cstsourcecolumns
  • _cstcodelistitemsds
  • _cstmdvDS
  • _cststudyds
  • _cstcodelistsds
  • _cstCLlang
  • _cstoutclitemdecodetransds
File: crtdds_clitemdecodetrans.sas

%crtdds_codelistitems

%crtdds_codelistitems(_cstsourcecolumns=, _cstcodelistsds=, _cstoutcodelistitemsds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcecolumns
  • _cstcodelistsds
  • _cstoutcodelistitemsds
File: crtdds_codelistitems.sas

%crtdds_codelists

%crtdds_codelists(_cstsourcecolumns=, _cstmdvds=, _cstmdvname=, _cstoutcodelistsds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcecolumns
  • _cstmdvds
  • _cstmdvname
  • _cstoutcodelistsds
File: crtdds_codelists.sas

%crtdds_computationmethods

%crtdds_computationmethods(_cstsourcecolumns=, _cstsourcestudy=, _cstmdvds=, _cstitemdefsds=, _cststudyds=, _cstoutcomputationmethodsds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcecolumns
  • _cstsourcestudy
  • _cstmdvds
  • _cstitemdefsds
  • _cststudyds
  • _cstoutcomputationmethodsds
File: crtdds_computationmethods.sas

%crtdds_definedocument

%crtdds_definedocument(_cstname=, _cstdescr=, _cstoutdefinedocds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstname
  • _cstdescr
  • _cstoutdefinedocds
File: crtdds_definedocument.sas

%crtdds_getStatic

%crtdds_getStatic(_cstName=, _cstVar=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstName
  • _cstVar
File: crtdds_getstatic.sas

%crtdds_itemdefs

%crtdds_itemdefs(_cstsourcecolumns=, _cstsourcestudy=, _cststudyds=, _cstmdvds=, _cstcodelistsDS=, _cstoutitemdefsds=, _cstoutitemdefsds2=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcecolumns
  • _cstsourcestudy
  • _cststudyds
  • _cstmdvds
  • _cstcodelistsDS
  • _cstoutitemdefsds
  • _cstoutitemdefsds2
File: crtdds_itemdefs.sas

%crtdds_itemgroupdefitemrefs

%crtdds_itemgroupdefitemrefs(_cstsourcecolumns=, _cstsourcetables=, _cstsourcestudy=, _cstitemdefsds2=, _cstmdvds=, _cstitemgroupdefsds=, _cststudyds=, _cstoutitemgroupdefitemrefsds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcecolumns
  • _cstsourcetables
  • _cstsourcestudy
  • _cstitemdefsds2
  • _cstmdvds
  • _cstitemgroupdefsds
  • _cststudyds
  • _cstoutitemgroupdefitemrefsds
File: crtdds_itemgroupdefitemrefs.sas

%crtdds_itemgroupdefs

%crtdds_itemgroupdefs(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupdefsds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcetables
  • _cstsourcestudy
  • _cststudyds
  • _cstmdvDS
  • _cstoutitemgroupdefsds
File: crtdds_itemgroupdefs.sas

%crtdds_itemgroupleaf

%crtdds_itemgroupleaf(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupleafds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcetables
  • _cstsourcestudy
  • _cststudyds
  • _cstmdvDS
  • _cstoutitemgroupdefsds
File: crtdds_itemgroupleaf.sas

%crtdds_itemgroupleaftitles

%crtdds_itemgroupleaftitles(_cstsourcetables=, _cstsourcestudy=, _cststudyds=, _cstmdvDS=, _cstoutitemgroupleaftitlesds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstsourcetables
  • _cstsourcestudy
  • _cststudyds
  • _cstmdvDS
  • _cstoutitemgroupdefsds
File: crtdds_itemgroupleaftitles.sas

%crtdds_metadataversion

%crtdds_metadataversion(_cstname=, _cstdescr=, _cststandard=, _cstversion=, _cstdefineversion=, _cststudyds=, _cststudyname=, _cstoutmdvds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstname
  • _cstdescr
  • _cststandard
  • _cstversion
  • _cstdefineversion
  • _cststudyds
  • _cststudyname
  • _cstoutmdvds
File: crtdds_metadataversion.sas

%crtdds_read

%crtdds_read;
[Exposure: external] [Macro Type: CRTDDS]
Reads a CDISC CRT-DDS 1.0 (define.xml) XML file into the SAS representation of CRT-DDS 1.0.
This macro uses the SAS representation of a CDISC CRT-DDS XML file as source, and converts it into SAS data sets. The inputs and outputs are specified in a SASReferences file.
Required global macro variables:
  • Framework initialization properties.
  • CDISC CRT-DDS 1.0 initialization properties.
  • _cstResultsDS should point to an existing Results data set. Otherwise, work._cstResults is used.
File: crtdds_metadataversion.sas

%crtdds_sdtm311todefine10

%crtdds_sdtm311todefine10(_cstOutLib=, _cstSourceTables=, _cstSourceColumns=, _cstSourceStudy=);
[ Exposure: external ] [ Macro Type: CRT-DDS ]
Populates 12 of the 39 tables in the SAS representation of the CRT-DDS standard.
This macro extracts data from the SDTM metadata files, and converts the metadata into a subset (12) of the tables in the SAS representation of the CRT-DDS model. The following CRT-DDS tables are created:
  • clitemdecodetranslatedtext
  • codelistitems
  • codelists
  • computationmethods
  • definedocument
  • itemdefs
  • itemgroupdefitemrefs
  • itemgroupdefs
  • itemgroupleaf
  • itemgroupleaftitles
  • metadataversion
  • study
The metadata source is specified in a SASReferences file.
Required global macro variables:
  • framework initialization properties
  • CRT-DDS 1.0 initialization properties
  • _cstresultsds should point to an existing Results data set
Parameters:
  • _cstOutLib—Required. Identifies library reference where the resulting tables should be written to.
  • _cstSourceTables—Required. A data set that contains the SDTM metadata for the domains to be included in the CRT-DDS file.
  • _cstSourceColumns—Required. A data set that contains the SDTM metadata for the domain columns to be included in the CRT-DDS file.
  • _cstSourceStudy—Required. A data set that contains the metadata for the studies to be included in the CRT-DDS file.
File: crtdds_sdtm311todefine10.sas

%crtdds_study

%crtdds_study(_cstname=, _cstdescr=, _cstprotocol=, _cstdefineds=, _cstdefinename=, _cstoutstudyds=);
[ Exposure: Not specified ] [ Macro Type: Not specified ]
Parameters:
  • _cstname
  • _cstdescr
  • _cstprotocol
  • _cstdefineds
  • _cstdefinename
  • _cstoutstudyds
File: crtdds_study.sas

%crtdds_validate

%crtdds_validate /des='CST: Validate CDISC CRTDDS model files';
[ Exposure: external ] [ Macro Type: CRTDDS Validation Process ]
crtdds_validate
Validate CDISC CRT-DDS model files.
The basic function of this code module is to cycle through the validation checks to be run, writing validation results to the process Results and Metrics data sets. These data sets are persisted to any permanent location based on type=results records in a SASReferences file. Process cleanup is based on the _cstDebug global macro variable.
Required global macro variables (beyond reporting and debugging variables):
(none)
Required File Inputs:
run-time (type=control,subtype=validation in a SASReferences file) check data set
File: crtdds_validate.sas

%crtdds_write

%crtdds_write(_cstCreateDisplayStyleSheet=1, _cstOutputEncoding=, _cstHeaderComment=, _cstResultsOverrideDS=, _cstLogLevel=info);
[ Exposure: external ] [ Macro Type: CRT-DDS ]
Writes a CDISC CRT-DDS V1.0 XML file.
This macro uses the SAS representation of a CRT-DDS file as source data, and converts it to the required XML structure. The inputs and outputs are specified in a SASReferences file.
Required global macro variables:
  • framework initialization properties
  • CRT-DDS 1.0 initialization properties
  • _cstresultsds should point to an existing Results data set, or it should override this value using the _cstResultsOverrideDS parameter to this macro
Parameters:
  • _cstCreateDisplayStyleSheet—Optional. Identifies whether the macro should create a style sheet in the same directory as the output XML file. If this is set to 1, then the macro looks in the provided SASReferences file for a record with a type and subtype of referencexml and stylesheet, and uses that file. If this is set to 0, then the macro does not create the XSL, even if one is specified in the SASReferences file.
  • _cstOutputEncoding—Optional. The XML encoding to use for the CRT-DDS file that is created.
  • _cstHeaderComment—Optional. A short comment is added to the top of the CRT-DDS file that is produced. If none is provided, then a default is used.
  • _cstResultsOverrideDS—Optional. The (LIBNAME.)member that refers to a Results data set to be created. If omitted, then the Results data set specified by the &_cstResultsDS is used.
  • _cstLogLevel—Optional. Identifies the level of error reporting. Valid values are Info, Warning, Error, and Fatal Error.
File: crtdds_write.sas

%crtdds_xmlvalidate

%crtdds_xmlvalidate(_cstLogLevel=info, _cstResultsOverrideDS=);
[ Exposure: external ] [ Macro Type: CRT-DDS ]
Performs XML-level (not SAS) validation on a CRT-DDS V1.0 XML file.
General use of this macro is in combination with another macro (such as crtdds_write or crtdds_read). Conditional code is included that writes metadata to the Results data set, and checks the validity of the SASReferences data set if this macro is run independently.
Parameters:
  • _cstLogLevel—Optional. Identifies the level of error reporting. Valid values are Info, Warning, Error, and Fatal Error.
  • _cstResultsOverrideDS—Optional. The (LIBNAME.)member that refers to a Results data set to be created. If omitted, then the Results data set specified by the &_cstResultsDS is used.
File: crtdds_xmlvalidate.sas

%crtddsutil_buildchecktablelist

%crtddsutil_buildchecktablelist(_cstCheckDS=, _cstWhereClause=, _cstOutputDS=);
[ Exposure: internal ] [ Macro Type: Framework utility]
Builds a data set that identifies the domains to be validated by each check. This is based on the contents of the validation check data set columns tablescope and columnscope.
Required global macro variables:
(none)
Required File Inputs:
only as specified in the parameters
Parameters:
  • _cstCheckDS—The validation check data set that contains the checks for a standard and standardversion. Typically, this is the Validation Master data set.
  • _cstWhereClause—Optional. A WHERE clause to subset _cstCheckDS. The syntax should comply with a SAS statement argument, such as any of the following: VAR1=1 or upcase(var2)="Y" or checkstatus>0.
  • _cstOutputDS—The output data set that is returned to the calling program. This data set contains a record for each domain that is referenced by a checkid, standardversion, and checksource.
File: crtddsutil_buildchecktablelist.sas
Copyright © SAS Institute Inc. All rights reserved.