Model Documentation

Class: AnalysisMethod

The AnalysisMethod class is used in the reporting event's methods attribute to specify the analysis methods used by any analysis in the reporting event. Each analysis method represents a standalone specification of a set of 1 or more statistical operations that can be applied to any analysis variable to generate a set of analysis results.

For example, a "summary by group of a categorical variable" method might include separate operations for "count of subject by group" and "percent of subjects by group". This defined method could then be used to summarize any categorical variable across any number of grouping factors.
ER Diagram: AnalysisMethod

Each analysis method is defined as an instance of the AnalysisMethod class and, in each instance:

  • The id attribute contains the identifier value assigned for the analysis method.
  • The name attribute indicates the assigned name of the analysis method.
  • The label attribute contains a short description of the analysis method.
  • The description attribute may be used to record a detailed description of the analysis method.
  • One or more references to associated documentation for the analysis method may be included in the documentRefs attribute, as described in the DocumentReference section.
  • The operations attribute contains the specification(s) of 1 or more statistical operations, each of which is represented as an instance of the Operation class, as described in the Operation section.
  • Any template programming code for the generation of the results of any analysis that uses the analysis method may be recorded or referenced in the codeTemplate attribute, as described in the AnalysisProgrammingCodeTemplate section.

Example

This example shows the definition of a simple analysis method that contains only 1 operation. This method could be used to calculate the number of subjects in each treatment group for any analysis set. The results of the analyses that use this method could then by referenced as the denominator by other defined "percent of subjects" operations.
YAML Example
methods:
- id: Mth01_CatVar_Count_ByGrp
  name: Count by group for a categorical variable
  description: Count across groups for a categorical variable, based on subject occurrence
  label: Grouped count for categorical variable
  operations:
  - id: Mth01_CatVar_Count_ByGrp_1_n
    name: Count of subjects
    label: n
    order: 1
    resultPattern: (N=XX)
...

This analysis method could be represented in tabular form as shown in the following table where the column names for attributes of the Operation class include the prefix, "operation_":

$titleHtml
idnamedescriptionlabeloperation_idoperation_nameoperation_labeloperation_orderoperation_resultPattern
Mth01_CatVar_Count_ByGrpCount by group for a categorical variableCount across groups for a categorical variable, based on subject occurrenceGrouped count for categorical variableMth01_CatVar_Count_ByGrp_1_nCount of subjectsn1(N=XX)
$warningHtml

Additional examples of method definitions can be found in the Operation and OperationResult sections.

Once an analysis method has been defined, its use in an analysis is specified by inclusion of its identifier value in the methodId attribute of the analysis, as described in the Analysis section.

« GroupingFactor

Operation »

  • No labels