Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed reference to GroupingFactor as an abstract class with specializations, changed class diagram to ER diagram, included examples (ARSP-28), added references to name and description attributes (GitHub #217) and changed description of compound expression to include reference to WhereClause (GitHub #136/#221)
Info
titleModel Documentation

Class: GroupingFactor

The abstract GroupingFactor class provides a template for the structure of its 2 specializations:

...

is used in the reporting event's analysisGroupings attribute to define

...

grouping factors, which are characteristics used to subdivide the subject population or analysis dataset records into groups for analysis

...

. Examples of grouping factors include subject characteristics (such as sex or age group), planned or actual treatment, "system organ class" or "preferred term" in an adverse events analysis dataset, and "parameter" or "visit" in a vital signs analysis dataset

...

.

Excerpt Include
ARSP:Class ER Diagram: GroupingFactor
ARSP:Class ER Diagram: GroupingFactor

Each grouping factor is represented as an instance of 1 of the specializations of the GroupingFactor class and, in each instance:

  • The id attribute contains the assigned identifier value for the grouping factor.
  • The label The name attribute contains a short description the name of the grouping factor (e.g., "Treatment" or , "Sex" for a subject grouping factor, "System Organ Class" or "Vital Signs Parameter" for a data grouping factor)).
  • The description attribute may be used to record a detailed description of the grouping factor.
  • The label attribute may be used to record a short description of the grouping factor.
  • The groupingDataset and groupingVariable attributes may contain, respectively, the dataset name and variable name of the variable whose values are used to subdivide subjects or data records. This attributeThese attributes:
    • May be blank for groupings that include predefined groups that are specified using compound expressions that reference more than one variable.
    • Must be populated for data-driven groupings.
  • The dataDriven attribute contains either "true" or "false" to indicate whether the grouping factor is data-driven. The groups within a data-driven grouping factor (where dataDriven = true) are not predefined; they are determined from the distinct values contained within the specified groupingVariable.
  • For grouping factors that are not data-driven (dataDriven = false), the groups attribute contains the specifications of 2 or more predefined groups, each represented as an instance of the specialization of the Group class that corresponds with the specialization of the GroupingFactor class:The AnalysisGroup class is used to specify predefined groups in the SubjectGroupingFactor class.The DataGroup class is used to specify

When predefined groups are specified in the

...

When predefined groups are specifiedgroups attribute, each predefined group is defined as an instance of the appropriate specialization of the Group class (which is itself a specialization of the WhereClause class). In each instance ,of the Group class:

  • The id attribute contains the assigned identifier value for the predefined group.
  • The label name attribute contains a short description the assigned name for the predefined group, for example:
Example
inlinetrue
    • "Placebo" or the active treatment name in a "Treatment" grouping factor,
    • "Male" or "Female" in a "Sex" grouping factor,
    • "Screening Visit" or "Visit 1" in a "Visit" grouping factor
  • The description attribute may be used to record a detailed description of the predefined group.
  • The label attribute may be used to record a short description of the predefined group, such as might be used in a display with limited space.
  • The level attribute is assigned a value of "1".
  • The order attribute contains an integer used to order the predefined group with respect to the other predefined groups in the grouping factor (i.e., "1" for the first predefined group, "2" for the second, and so on). The value of this attribute is assigned according to the order in which the predefined groups should be displayed in outputs.
  • Either:

...

    • The compoundExpression attribute contains the definition of a compound expression represented as an instance of the CompoundGroupExpression 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 specialization subclauses being combined or negated by the specified logical operator. Each subclause is represented as an instance of either the ReferencedGroup class (whose subClauseId attribute contains the identifier value of another instance of the Group class that is the same as the one in which the compound expression is being defined. Each reference is represented as an identifier value.) or the WhereClause class (containing the subclause defined using either the condition or compoundExpression attribute).

Refer to the WhereClauseCompoundExpression section for more information about compound expressions.

Note

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 specify predefined groups within grouping factors will usually have been applied to create specific grouping variables. These grouping variables can usually then be referenced in the specification of simple conditions, so compound expressions should generally not be required for the definition of predefined groups within grouping factors.

...

Example

Include Page
analysisGroupings
analysisGroupings

Example

Include Page
dataGroupings
dataGroupings

Once a grouping factor has been defined in the analysisGroupings or dataGroupings attribute of the reporting event, it can be used in the specification of any analysis by including its identifier value in the groupingId attribute of 1 of the instances of the OrderedGroupingFactor class in the orderedGroupings attribute of the analysis. In general, grouping factors are defined with reference to a single grouping variable. However, multiple separate grouping factors may be referenced in the specification of an analysis, so it is possible to define analyses of subjects and data records that are grouped by multiple factors.

...