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.

...

Each operation generates a single result for each combination of groups in any "results-by-group" grouping factors included in the specification of an analysis that references the analysis method containing the operation (see the Analysis and OperationResult sections for more information about "results-by-group" grouping factors). Each result is generally expected to represent a single value, but sponsors may choose to define operations that generate composite results as a combination of more than 1 individual value. However, the disadvantage of composite results is that there will not be individual metadata elements to describe each component of a composite result. A better approach is to define operations that generate individual result values and then, if necessary, combine the result values from these operations to produce a composite value for display.

Excerpt Include
ARSP:ER Diagram: Operation
ARSP:ER Diagram: Operation

Each operation is defined as an instance of the Operation class and, in each instance:

  • 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 contains may be used to record a short label for the operation, such as might be shown in an output display (e.g., "n", "%", "Mean", "SD").
  • The order 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.

...

  • 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:
    • A description of the referenced operation
      Jira
      showSummaryfalse
      serverIssue Tracker (JIRA)
      serverId85506ce4-3cb3-3d91-85ee-f633aaaf4a45
      keyARSP-22
      and operation and how its results are used.
    • An indication of which analyses are expected to produce the required result values, which may be helpful in situations when the analysisId is not provided in the referenced operation relationship.

...