Model Documentation
Class: AnalysisSet
The AnalysisSet class, which is a specialization of the WhereClause class, is used in the reporting event's analysisSets attribute to specify the analysis sets, or subject populations, that define the sets of subjects whose data are to be included in the main analyses, as defined in the statistical section of the protocol. Once an analysis set has been defined in the reporting event's analysisSets attribute, it can be used for any analysis by specifying its identifier value in the analysisSetId attribute of the instance of the Analysis class that represents the analysis, as described in the Analysis section.
Each analysis set is defined as an instance of the AnalysisSet class, in which:
- The id attribute contains the assigned identifier value for the analysis set.
- The label attribute contains a short description for the analysis set (e.g., "Safety Population").
- The level and order attributes are both assigned a value of "1".
- Either:
- The condition attribute contains the definition of a simple data selection criterion represented as an instance of the WhereClauseCondition class, as described in the WhereClauseCondition section.
Or:
- The compoundExpression attribute contains the definition of a compound expression represented as an instance of the CompoundSetExpression class, in which:
- The logicalOperator attribute contains a value from the ExpressionLogicalOperatorEnum enumeration.
- The whereClauses attribute contains 1 or more references to other instances of the AnalysisSet class represented as identifier values.
- The compoundExpression attribute contains the definition of a compound expression represented as an instance of the CompoundSetExpression class, in which:
Refer to the WhereClauseCompoundExpression section for more information about compound expressions.
Example
Lines 2-13: | Show the "Safety Population" analysis set defined as a simple condition that specifies that the value of the SAFFL variable in the ADSL dataset is equal to "Y". This condition could be expressed as:
|
Lines 14-25: | Show the "Region X Population" analysis set defined as a simple condition that specifies that the value of the RGXFL variable in the ADSL dataset is equal to "Y". This condition could be expressed as:
|
Lines 26-40: | Show the "Region X Safety Population" analysis set defined as a compound expression that uses the "AND" logical operator to combine the conditions specified for the "Region X Population" and "Safety Population" analysis sets (meaning that only subjects meeting both conditions are included in the analysis set ). When the references to the other analysis sets are resolved, this expression could be expressed as:
|
analysisSets: - id: AnalysisSet_SAF name: Safety Population description: All subjects randomized and known to have taken at least one dose of randomized drug label: SAF level: 1 order: 1 condition: dataset: ADSL variable: SAFFL comparator: EQ value: - Y - id: AnalysisSet_RGX name: Region X Population description: All subjects enrolled at sites in country A, B, or C label: RGX level: 1 order: 1 condition: dataset: ADSL variable: RGXFL comparator: EQ value: - Y - id: AnalysisSet_RGXSAF name: Region X Safety Population description: All subjects enrolled at sites in country A, B, or C, randomized, and known to have taken at least one dose of randomized drug label: RGXSAF level: 1 order: 1 compoundExpression: logicalOperator: AND whereClauses: - level: 2 order: 1 subClauseId: AnalysisSet_RGX - level: 2 order: 2 subClauseId: AnalysisSet_SAF
These analysis sets could be represented in tabular form as shown in the following table where:
- Each represents an instance of either the AnalysisSet class or, for subclauses in a compound expression, the ReferencedAnalysisSet class.
- The values of the id, name, description, and label attributes of the "AnalysisSet_RGXSAF" instance of the analysis set class have been propagated onto all rows representing subclauses defined within the analysis set.
- The logicalOperator attribute from the CompoundSetExpression class, the subClauseId attribute from the ReferencedAnalysisSet class, and all the attributes from the WhereClauseCondition class are represented as separate columns.
- Cells highlighted in yellow contain derived values: the values in the dataset, variable, comparator and value columns have been retrieved from the definitions of the analysis sets using the identifier values specified in the subClauseId attribute.
id | name | description | label | level | order | logicalOperator | subClauseId | dataset | variable | comparator | value |
---|---|---|---|---|---|---|---|---|---|---|---|
AnalysisSet_SAF | Safety Population | All subjects randomized and known to have taken at least one dose of randomized drug | SAF | 1 | 1 | ADSL | SAFFL | EQ | Y | ||
AnalysisSet_RGX | Region X Population | All subjects enrolled at sites in country A, B, or C | RGX | 1 | 1 | ADSL | RGXFL | EQ | Y | ||
AnalysisSet_RGXSAF | Region X Safety Population | All subjects enrolled at sites in country A, B, or C, randomized, and known to have taken at least one dose of randomized drug | RGXSAF | 1 | 1 | AND | |||||
AnalysisSet_RGXSAF | Region X Safety Population | All subjects enrolled at sites in country A, B, or C, randomized, and known to have taken at least one dose of randomized drug | RGXSAF | 2 | 1 | AnalysisSet_RGX | ADSL | RGXFL | EQ | Y | |
AnalysisSet_RGXSAF | Region X Safety Population | All subjects enrolled at sites in country A, B, or C, randomized, and known to have taken at least one dose of randomized drug | RGXSAF | 2 | 2 | AnalysisSet_SAF | ADSL | SAFFL | EQ | Y |
Note that the ARS model is designed to support the specification of analyses of data in ADaM datasets, which are expected to be "analysis-ready". In analysis-ready datasets, any complex criteria needed to define analysis sets will usually have been applied to create population flag variables. These population flag variables can usually then be referenced in the specification of simple conditions, so compound expressions should generally not be required for the definition of analysis sets.