Class: Analysis

An analysis that is designed to meet a requirement of the reporting event. Each analysis is defined as a set of specifications, including:

  • The analysis variable that is the subject of the analysis.

  • The analysis method (set of statistical operations) that is performed for the analysis variable.

  • The analysis set (subject population) for which the analysis is performed.

  • The subset of data records on which the analysis is performed (optional).

  • One or more factors by which either subjects or data records are grouped for analysis (optional).

URI: ars:Analysis

 classDiagram
    class Analysis
      NamedObject <|-- Analysis        
      Analysis : id
        Analysis : version
        Analysis : reason
        Analysis --|> ExtensibleTerminologyTerm : reason
        Analysis : purpose
        Analysis --|> ExtensibleTerminologyTerm : purpose
        Analysis : documentRefs
        Analysis --|> DocumentReference : documentRefs
        Analysis : categoryIds
        Analysis --|> AnalysisOutputCategory : categoryIds
        Analysis : dataset
        Analysis : variable
        Analysis : analysisSetId
        Analysis --|> AnalysisSet : analysisSetId
        Analysis : dataSubsetId
        Analysis --|> DataSubset : dataSubsetId
        Analysis : orderedGroupings
        Analysis --|> OrderedGroupingFactor : orderedGroupings
        Analysis : methodId
        Analysis --|> AnalysisMethod : methodId
        Analysis : referencedAnalysisOperations
        Analysis --|> ReferencedAnalysisOperation : referencedAnalysisOperations
        Analysis : programmingCode
        Analysis --|> AnalysisOutputProgrammingCode : programmingCode
        Analysis : results
        Analysis --|> OperationResult : results
        Analysis : name
        Analysis : description
        Analysis : label
        

Inheritance

Slots

Name Cardinality* and Range Description Inheritance
id 1..1
String
The assigned identifying value for the instance of the class direct
version 0..1
Integer
An ordinal indicating the version of the identified instance of the class direct
reason 1..1
ExtensibleTerminologyTerm
The rationale for performing this analysis direct
purpose 1..1
ExtensibleTerminologyTerm
The purpose of the analysis within the body of evidence (e direct
documentRefs 0..*
DocumentReference
References to external documents containing additional information direct
categoryIds 0..*
AnalysisOutputCategory
References to any implementer-defined categories that apply to the analysis direct
dataset 0..1
String
The name of the analysis dataset direct
variable 0..1
String
The name of the variable direct
analysisSetId 0..1
AnalysisSet
The identifier of the referenced analysis set direct
dataSubsetId 0..1
DataSubset
The identifier of the referenced data subset direct
orderedGroupings 0..*
OrderedGroupingFactor
An ordered list of grouping factors used in the analysis direct
methodId 1..1
AnalysisMethod
A reference to the set of one or more statistical operations performed for th... direct
referencedAnalysisOperations 0..*
ReferencedAnalysisOperation
Indications of which analysis contains the results for each referenced operat... direct
programmingCode 0..1
AnalysisOutputProgrammingCode
Programming statements and/or a reference to the program used to perform the ... direct
results 0..*
OperationResult
The results of the analysis direct
name 1..1
String
The name for the instance of the class NamedObject
description 0..1
String
A textual description of the instance of the class NamedObject
label 0..1
String
A short informative description that may be used for display NamedObject

* See LinkML documentation for cardinality definitions.

Usages

used by used in type used
ReportingEvent analyses range Analysis
OrderedListItem analysisId range Analysis
ReferencedOperationRelationship analysisId range Analysis
ReferencedAnalysisOperation analysisId range Analysis

Identifier and Mapping Information

Schema Source

  • from schema: https://www.cdisc.org/ars/1-0

Mappings

Mapping Type Mapped Value
self ars:Analysis
native ars:Analysis

LinkML Source

Direct

name: Analysis
description: 'An analysis that is designed to meet a requirement of the reporting
  event. Each analysis is defined as a set of specifications, including:

  * The analysis variable that is the subject of the analysis.

  * The analysis method (set of statistical operations) that is performed for the
  analysis variable.

  * The analysis set (subject population) for which the analysis is performed.

  * The subset of data records on which the analysis is performed (optional).

  * One or more factors by which either subjects or data records are grouped for analysis
  (optional).'
from_schema: https://www.cdisc.org/ars/1-0
rank: 1000
is_a: NamedObject
slots:
- id
- version
- reason
- purpose
- documentRefs
- categoryIds
- dataset
- variable
- analysisSetId
- dataSubsetId
- orderedGroupings
- methodId
- referencedAnalysisOperations
- programmingCode
- results
slot_usage:
  categoryIds:
    name: categoryIds
    description: References to any implementer-defined categories that apply to the
      analysis.
    domain_of:
    - Analysis
    - Output
  programmingCode:
    name: programmingCode
    description: Programming statements and/or a reference to the program used to
      perform the specific analysis.
    domain_of:
    - Analysis
    - Output

Induced

name: Analysis
description: 'An analysis that is designed to meet a requirement of the reporting
  event. Each analysis is defined as a set of specifications, including:

  * The analysis variable that is the subject of the analysis.

  * The analysis method (set of statistical operations) that is performed for the
  analysis variable.

  * The analysis set (subject population) for which the analysis is performed.

  * The subset of data records on which the analysis is performed (optional).

  * One or more factors by which either subjects or data records are grouped for analysis
  (optional).'
from_schema: https://www.cdisc.org/ars/1-0
rank: 1000
is_a: NamedObject
slot_usage:
  categoryIds:
    name: categoryIds
    description: References to any implementer-defined categories that apply to the
      analysis.
    domain_of:
    - Analysis
    - Output
  programmingCode:
    name: programmingCode
    description: Programming statements and/or a reference to the program used to
      perform the specific analysis.
    domain_of:
    - Analysis
    - Output
attributes:
  id:
    name: id
    description: The assigned identifying value for the instance of the class.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    identifier: true
    alias: id
    owner: Analysis
    domain_of:
    - ReportingEvent
    - ReferenceDocument
    - TerminologyExtension
    - SponsorTerm
    - AnalysisOutputCategorization
    - AnalysisOutputCategory
    - AnalysisSet
    - DataSubset
    - GroupingFactor
    - Group
    - AnalysisMethod
    - Operation
    - ReferencedOperationRelationship
    - Analysis
    - DisplaySubSection
    - Output
    - OutputDisplay
    range: string
    required: true
  version:
    name: version
    description: An ordinal indicating the version of the identified instance of the
      class.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: version
    owner: Analysis
    domain_of:
    - ReportingEvent
    - Analysis
    - Output
    - OutputDisplay
    range: integer
  reason:
    name: reason
    description: The rationale for performing this analysis. It indicates when the
      analysis was planned.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: reason
    owner: Analysis
    domain_of:
    - Analysis
    range: ExtensibleTerminologyTerm
    required: true
    any_of:
    - range: AnalysisReason
    - range: SponsorAnalysisReason
  purpose:
    name: purpose
    description: The purpose of the analysis within the body of evidence (e.g., section
      in the clinical study report).
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: purpose
    owner: Analysis
    domain_of:
    - Analysis
    range: ExtensibleTerminologyTerm
    required: true
    any_of:
    - range: AnalysisPurpose
    - range: SponsorAnalysisPurpose
  documentRefs:
    name: documentRefs
    description: References to external documents containing additional information.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: documentRefs
    owner: Analysis
    domain_of:
    - AnalysisMethod
    - Analysis
    - Output
    range: DocumentReference
    inlined: true
    inlined_as_list: true
  categoryIds:
    name: categoryIds
    description: References to any implementer-defined categories that apply to the
      analysis.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: categoryIds
    owner: Analysis
    domain_of:
    - Analysis
    - Output
    range: AnalysisOutputCategory
    required: false
    inlined: false
  dataset:
    name: dataset
    description: The name of the analysis dataset.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: dataset
    owner: Analysis
    domain_of:
    - WhereClauseCondition
    - Analysis
    range: string
  variable:
    name: variable
    description: The name of the variable.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: variable
    owner: Analysis
    domain_of:
    - WhereClauseCondition
    - Analysis
    range: string
  analysisSetId:
    name: analysisSetId
    description: The identifier of the referenced analysis set.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: false
    alias: analysisSetId
    owner: Analysis
    domain_of:
    - Analysis
    range: AnalysisSet
    inlined: false
  dataSubsetId:
    name: dataSubsetId
    description: The identifier of the referenced data subset.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: dataSubsetId
    owner: Analysis
    domain_of:
    - Analysis
    range: DataSubset
    inlined: false
  orderedGroupings:
    name: orderedGroupings
    description: An ordered list of grouping factors used in the analysis.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    list_elements_ordered: true
    alias: orderedGroupings
    owner: Analysis
    domain_of:
    - Analysis
    range: OrderedGroupingFactor
    inlined: true
    inlined_as_list: true
  methodId:
    name: methodId
    description: A reference to the set of one or more statistical operations performed
      for the analysis.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: methodId
    owner: Analysis
    domain_of:
    - Analysis
    range: AnalysisMethod
    required: true
    inlined: false
  referencedAnalysisOperations:
    name: referencedAnalysisOperations
    description: Indications of which analysis contains the results for each referenced
      operation.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: referencedAnalysisOperations
    owner: Analysis
    domain_of:
    - Analysis
    range: ReferencedAnalysisOperation
    inlined: true
    inlined_as_list: true
  programmingCode:
    name: programmingCode
    description: Programming statements and/or a reference to the program used to
      perform the specific analysis.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: programmingCode
    owner: Analysis
    domain_of:
    - Analysis
    - Output
    range: AnalysisOutputProgrammingCode
  results:
    name: results
    description: The results of the analysis.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: results
    owner: Analysis
    domain_of:
    - Analysis
    range: OperationResult
    inlined: true
    inlined_as_list: true
  name:
    name: name
    description: The name for the instance of the class.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: name
    owner: Analysis
    domain_of:
    - NamedObject
    range: string
    required: true
  description:
    name: description
    description: A textual description of the instance of the class.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: description
    owner: Analysis
    domain_of:
    - NamedObject
    - SponsorTerm
    - ReferencedOperationRelationship
    range: string
  label:
    name: label
    description: A short informative description that may be used for display.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: label
    owner: Analysis
    domain_of:
    - NamedObject
    - AnalysisOutputCategorization
    - AnalysisOutputCategory
    - PageRef
    range: string