Versions Compared

Old Version 6

changes.mady.by.user Richard Marshall

Saved on

compared with

New Version Current

changes.mady.by.user Alana St. Clair

Saved on

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.

Example
inlinetrue

Examples of operations include:

  • "Count of subjects by group" and "Percent of subjects by group" in a "Summary by group of a categorical variable" method.
  • "Mean", "Standard Deviation", "Minimum Value", "Maximum Value", and confidence intervals in a "Summary by group of a continuous variable" method.
  • "P-value" in a "Pearson's chi-square test group comparison for a categorical variable" method.

Each operation generates a single result for each combination of groups in any "results-by-group" grouping factors referenced by 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.

...

  • 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 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 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 , or referenced, in this in the dependent operation's calculation. Each relationship is defined as an instance of the ReferencedOperationRelationship class, in which:

  • The id attribute contains the identifier value assigned for the relationship.
  • The referencedOperationRole attribute contains attribute contains an indication of the role that the results of the referenced operation play in the calculation of the dependent operation. The role is represented as an instance of 1 of the two 2 specializations of the ExtensibleTerminologyTerm class for the OperationRoleEnum enumeration:
    • OperationRole, in which the controlledTerm attribute contains a file type role from the OperationRoleEnum enumeration
    • SponsorOperationRole, in which the sponsorTermId attribute contains the identifier of a sponsor term created in the terminology extension for the OperationRoleEnum enumeration. In this case, the submissionValue attribute of the referenced sponsor term contains the name of the role. 

Refer to the See the TerminologyExtension and ExtensibleTerminologyTerm sections for more information about the definition and use of terminology extensions, including examples.

  • 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 The analysisId attribute is only used if the results of the referenced operation are always generated by the same analysis. If the referenced analysis producing the required results may differ depending on which for each analysis that uses the method containing the dependent operation being defined, then the analysis that generates the results of the referenced operation referenced analysis may be specified in the the referencedAnalysisOperations attribute of the analysis that uses this the dependent operation (as described below).
  • The description attribute may be used to record a 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 .

For example,

    • in the referenced operation relationship.

The identifier of the analysis that produces the results of the referenced operation (the "referenced analysis identifier") must be specified. If it is not included in the definition of the referenced operation relationship (i.e., the analysisId attribute of an instance of the ReferencedOperationRelationship class is not used), then the referenced analysis identifier must be specified as part of the definition of any analysis that uses the method containing the dependent operation. The referenced analysis identifier should not be specified in both the definition of the referenced operation relationship and the definition of an analysis that uses the dependent operation. When the referenced analysis identifier is specified as part of the definition of an analysis that uses the dependent operation, it is specified in the referencedAnalysisOperations attribute of the analysis in an instance of the ReferencedAnalysisOperation class, in which:

  • The referencedOperationRelationshipId attribute contains the identifier value of the referenced operation relationship.
  • The analysisId attribute contains the referenced analysis identifier.
Example

Include Page
operations
operations

Example
inlinetrue
  • "The count operation whose result provides the numerator for calculation of the percentage. The referenced analysis should be the analysis that contains this percent operation."
    • "The count operation whose result provides the denominator for calculation of the percentage. The referenced analysis should have the same analysis set and subject grouping factor(s) as the analysis containing this percent operation."

    Pagenav