You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

A MethodDef defines how a data value can be obtained from a collection of other data values.

Element NameMethodDef
Parent ElementsMetaDataVersion
Element XPath(s)/ODM/Study/MetaDataVersion/MethodDef
Element Textual ValueNone
AttributesOID, Name, Type, CommentOID
Child Elements

(Description, MethodSignature, FormalExpression*, Alias*, DocumentRef*)

The Description element must be provided and should include a prose description. The MethodSignature element must also be provided and identifies the input parameter and return values for the MethodDef. The Description and MethodSignature are the normative content of the MethodDef.

If a FormalExpression is provided, it must contain a machine-readable expression that implements the Description and MethodSignature. Multiple FormalExpressions can be provided if each has a different Context attribute, allowing the same expression to be represented in forms appropriate to multiple systems. A FormalExpression can reference an external code library such that it can be retrieved for execution at run-time. If MethodDef execution order must be specified then use workflows for this purpose.

Usage/Business Rules
  • Business Rule(s):
    • There must be an MethodDef element for each unique MethodOID attribute value in the study.
    • The MethodOID attribute may be used on the ItemGroupRef or ItemRef elements.
    • MethodDefs associated with ItemRefs may only return a single value.
    • MethodDefs associated with ItemGroupRefs must return one value per ItemRef.

AttributeSchema Datatype or EnumerationUsageDefinitionBusiness Rules
OIDoidRequiredUnique identifer for the MethodDef element.The OID attribute value must be unique within the Study/MetaDataVersion.
NamenameRequiredHuman readable name for the method.The Name attribute must be unique within the set of MethodDef elements within a Study/MetadataVersion.
Type(Computation | Imputation | Transpose | Preload)Optional

Computation: derivation involving one or more variables.

Imputation: derivation based on other observations.

Transpose: conversion of rows to columns or vice versa.

Preload: retrieve and populate data from an external source.

Type="Preload" is the default value when a MethodDef is referenced from an ItemGroup.
CommentOIDoidrefOptionalReference to a CommentDef with information related to this MethodDef.Must match the OID attribute of a CommentDef element within in this Study/MetaDataVersion.

 The Description element must be provided and should include a prose description. The MethodSignature element must also be provided and identifies the input parameter and return values for the MethodDef. The Description and MethodSignature are the normative content of the MethodDef.

If a FormalExpression is provided, it must contain a machine-readable expression that implements the Description and MethodSignature. Multiple FormalExpressions can be provided if each has a different Context attribute, allowing the same expression to be represented in forms appropriate to multiple systems. A FormalExpression can reference an external code library such that it can be retrieved for execution at run-time. If MethodDef execution order must be specified then use workflows for this purpose.

  • No labels