Metadata Type
|
ADaM Document Source
|
---|---|
Analysis Data Set
|
Section 5.1, Analysis
Data Set Metadata, Table 5.1.1
|
Analysis Variable
|
Section 5.2, Analysis
Variable Metadata, Table 5.2.1
|
Analysis Parameter
|
Section 5.2.1, Analysis
Parameter Value-Level Metadata
|
Analysis Results
|
Section 5.3, Analysis
Results Metadata, Table 5.3.1
|
global standards library directory/standards/cdisc-adam-2.1-1.7/metadata
Analysis Data Set Metadata
Field**
|
Description**
|
reference_tables Column
Mapping
|
---|---|---|
DATASET NAME
|
The file name of the
dataset, hyperlinked to the corresponding analysis dataset variable
descriptions (that is, the data definition table) within the define
file.
|
table
|
DATASET DESCRIPTION
|
A short descriptive
summary of the contents of the dataset
|
label
|
DATASET LOCATION
|
The folder and filename
where the dataset can be found, ideally hyperlinked to the actual
dataset (that is, XPT file)
|
xmlpath
|
DATASET STRUCTURE
|
The level of detail
represented by individual records in the dataset (for example,, “One
record per subject,” “One record per subject per visit,”
“One record per subject per event”).
|
structure
|
KEY VARIABLES OF DATASET
|
A list of variable names
that parallels the structure, ideally uniquely identifies and indexes
each record in the dataset.
|
keys
|
CLASS OF DATASET
|
Identification of the
general class of the dataset using the name of the ADaM structure
(that is, “ADAE”, “ADSL,” “BDS”)
or “OTHER” if not an ADaM-specified structure
|
class
|
DOCUMENTATION
|
Description of the source
data, processing steps, and analysis decisions pertaining to the creation
of the dataset. Software code of various levels of functionality and
complexity, such as pseudo-code or actual code fragments might be
provided. Links or references to external documents (for example,
protocol, statistical analysis plan, software code) might be used.
|
documentation
|
global standards library directory/standards/cdisc-adam-2.1-1.7/metadata
Analysis Variable Metadata
Field**
|
Description**
|
reference_columns Column
Mapping
|
---|---|---|
DATASET NAME
|
The filename of the
analysis dataset
|
table
|
VARIABLE NAME
|
The name of the variable
|
column
|
VARIABLE LABEL
|
A brief description
of the variable
|
label
|
VARIABLE TYPE
|
The variable type. Valid
values are as defined in the Case Report Tabulation Data Definition
Specification Standard (for example, in version 1.0.0 they include
“text,” “integer,” and “float”).
|
xmldatatype
|
DISPLAY FORMAT
|
The variable display
information (that is, the format used for the variable in a tabular
or graphical presentation of results). It is suggested that the syntax
be consistent with the format terminology incorporated in the software
application used for analysis (for example, $16 or 3.1 if using SAS).
|
displayformat
|
CODELIST / CONTROLLED
TERMS
|
A list of valid values
or allowable codes and their corresponding decodes for the variable.
The field can include a reference to an external codelist (identified
by name and version) or a hyperlink to a list of the values in the
codelist/controlled terms section of the define file.
|
xmlcodelist
|
SOURCE / DERIVATION
|
Provides details about
the variable’s lineage – what was the predecessor, where
the variable came from in the source data (SDTM or other analysis
dataset) or how the variable was derived. This field is used to identify
the immediate predecessor source and/or a brief description of the
algorithm or process applied to that sourceand can contain hyperlinked
text that refers readers to additional information. The source /
derivation can be as simple as a two-level name (for example, ADSL.AGEGR)identifying
the data file and variable that is the source of the variable (that
is, a variable copied with no change). It can be a simple description
of a derivation and the variable used in the derivation (for example,
“categorization of ADSL.BMI”). It can also be a complex
algorithm, where the element contains a complete description of the
derivation algorithm and/or a link to a document containing it and/or
a link to the analysis dataset creation program.
|
origin
comment
(supplemented by origin
and algorithm from the source metadata, such as SDTM)
|
sample study library directory/cdisc-adam-2.1-1.7/sascstdemodata/metadata
.
sample study library directory/cdisc-adam-2.1-1.7/sascstdemodata/metadata
. This sample file
can serve as a template to initialize your analysis results data set,
or see ADaM Data Set Templates.
Analysis Results Metadata
Field**
|
Description**
|
analysis_results Data
Set Column Mapping
|
---|---|---|
DISPLAY IDENTIFIER
|
A unique identifier
for the specific analysis display (such as a table or figure number)
|
dispid
|
DISPLAY NAME
|
Title of display, including
additional information if needed to describe and identify the display
(for example, analysis population)
|
dispname
|
RESULT IDENTIFIER
|
Identifies the specific
analysis result within a display. For example, if there are multiple
p-values on a display and the analysis results metadata specifically
refers to one of them, this field identifies the p-value of interest.
When combined with the display identifierprovides a unique identification
of a specific analysis result.
|
resultid
|
PARAM
|
The analysis parameter
in the BDS analysis dataset that is the focus of the analysis result.
Does not apply if the result is not based on a BDS analysis dataset.
|
param
|
PARAMCD
|
Corresponds to PARAM
in the BDS analysis dataset. Does not apply if the result is not based
on a BDS analysis dataset.
|
paramcd
|
ANALYSIS VARIABLE
|
The analysis variable
being analyzed
|
analvar
|
REASON
|
The rationale for performing
this analysis. It indicates when the analysis was planned (for example,
“Pre-specified in Protocol,” “Pre-specified in
SAP,” “Data Driven,” “Requested by Regulatory
Agency”) and the purpose of the analysis within the body of
evidence (for example,, “Primary Efficacy,” “Key
Secondary Efficacy,” “Safety”). The terminology
used is sponsor defined. An example of a reason is “Primary
Efficacy Analysis as Pre-specified in Protocol.”
|
reason
|
DATASET
|
The name of the dataset
used to generate the analysis result. In most cases, this is a single
dataset. However, if multiple datasets are used, they are all listed
here.
|
datasets
|
SELECTION CRITERIA
|
Specific and sufficient
selection criteria for analysis subset and / or numerator–
a complete list of the variables and their values used to identify
the records selected for the analysis. Though the syntax is not ADaM-specified,
the expectation is that the information could easily be included in
a WHERE clause or something equivalent to ensureselecting the exact
set of records appropriate for an analysis. This information is required
if the analysis does not include every record in the analysis dataset.
|
selcrit
|
DOCUMENTATION
|
Textual description
of the analysis performed. This information could be a text description,
pseudo code, or a link to another document such as the protocol or
statistical analysis plan, or a link to an analysis generation program
(that is, a statistical software program used to generate the analysis
result). The contents of the documentation metadata element contains
depends on the level of detail required to describe the analysis itself,
whether the sponsor is providing a corresponding analysis generation
program, and sponsor-specific requirements and standards. This documentation
metadata element will remain free form, meaning it will not become
subject to a rigid structure or controlled terminology.
|
document
|
PROGRAMMING STATEMENTS
|
The software programming
code used to perform the specific analysis. This includes, for example,
the model statement (using the specific variable names) and all technical
specifications needed for reproducing the analysis (for example, covariance
structure). The name and version of the applicable software application
should be specified either as part of this metadata element or in
another document, such as a Reviewer’s Guide. (See Appendix
B for more information about a Reviewer ’s Guide.)
|
progstmt
|