Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleModel Documentation

Class: Operation

The Operation class is class is used in the operations attribute of the AnalysisMethod class to define the statistical operations to be performed for any analysis that references the analysis method.

...

  • The id attribute contains the identifier value assigned for the operation.
  • The name attribute indicates the assigned name of the operation.
  • The description attribute may be used to record a detailed description of the operation.
  • The label attribute may be used to record label attribute contains a short label for the operation, such as might be shown in an output display (e.g., "n", "%", "Mean", "SD").
  • The description attribute may be used record a detailed description of the operation.The referencedOperationRelationships attribute may be used to specify relationships to any other operations whose results are referenced in the calculation of the results for this operation, as described beloworder attribute contains the order of the operation with respect to other operations in the same method ("1" for the first, "2" for the second, and so on).
  • The resultPattern attribute contains a textual representation for the default pattern or format used for the display of the results of this operation in output displays. The pattern should indicate the precision of the value to be displayed (e.g., "X.XXX") and may include parentheses or other additional characters (e.g., "(XXX.X)" or "±XX.XX"). In general, the pattern will usually be in the format that is displayed in output table shells, but sponsors may choose to use other pattern specifications.
  • The referencedOperationRelationships attribute may be used to specify relationships to any other operations whose results are referenced in the calculation of the results for this operation, as described below.

Some "dependent" operations may be defined to reuse the results of other "referenced" operations in the calculation of their result values. For example, an operation that calculates a percentage may reuse the results of other "count of subjects" operations to act as the numerator and denominator in the calculation of the percentage. In such operations, the referencedOperationRelationships attribute of the dependent operation is used to specify 1 or more relationships to the other referenced operation(s) whose results are used in the dependent operation's calculation. Each relationship is defined as an instance of the ReferencedOperationRelationship class, in which:

...

  • The operationId attribute contains the identifier value for the operation that is being referenced.
  • The analysisId attribute may contain the identifier of a "referenced analysis" (i.e., an analysis that uses the method that contains the referenced operation). The analysisId attribute is only used if the results of the referenced operation are always generated by the same analysis. If the referenced analysis may differ for each analysis that uses the method containing the dependent operation, then the referenced analysis may be specified in the referencedAnalysisOperations attribute of the analysis that uses the dependent operation (as described below).
  • The description attribute may be used to record details of the relationship, which may include:
    • In A description of the referenced operation and operation and how its results are used.
    • In An indication of which analyses are expected to produce the required result values, which may be helpful in situations when the the analysisId is not provided in the referenced operation relationship.

...