Skip to content

Class: Variable

Base class for all variable types. Contains common identification and description fields shared by all variables. Reference: OAPMetadata XSD variables.xsd - variable, basic_variable

URI: oae:Variable

classDiagram class Variable click Variable href "../Variable" BaseVariable <|-- Variable click BaseVariable href "../BaseVariable" Variable <|-- ObservedPropertyVariable click ObservedPropertyVariable href "../ObservedPropertyVariable" Variable <|-- CalculatedVariable click CalculatedVariable href "../CalculatedVariable" Variable : dataset_variable_name Variable : dataset_variable_name_qc_flag Variable : dataset_variable_name_raw Variable : long_name Variable : measurement_researcher Variable --> "0..1" Person : measurement_researcher click Person href "../Person" Variable : method_reference Variable : other_detailed_information Variable : standard_identifier Variable --> "0..1" VocabularyItemReference : standard_identifier click VocabularyItemReference href "../VocabularyItemReference" Variable : units

Inheritance

Slots

Name Cardinality and Range Description Inheritance
dataset_variable_name_qc_flag 0..1
String		 If applicable, the column header name used for the quality control flag corre... direct
dataset_variable_name_raw 0..1
String		 If applicable, the column header name used for the raw data corresponding to ... direct
method_reference 0..1
String		 Citation for the method used direct
measurement_researcher 0..1
Person		 The name of the PI whose research team measured or derived this parameter direct
other_detailed_information 0..1
String		 Any additional information about this variable direct
units 1
String		 Unit of measurement for this variable BaseVariable
standard_identifier 0..1
VocabularyItemReference		 BaseVariable
dataset_variable_name 1
String		 The name for the variable as it is identified in the dataset data file BaseVariable
long_name 1
String		 Full descriptive name of the variable BaseVariable

Usages

used by used in type used
FieldDataset variables range Variable

Identifier and Mapping Information

Schema Source

  • from schema: OAEDataManagementProtocol

Mappings

Mapping Type Mapped Value
self oae:Variable
native oae:Variable

LinkML Source

Direct

name: Variable
description: 'Base class for all variable types. Contains common identification and
  description fields shared by all variables. Reference: OAPMetadata XSD variables.xsd
  - variable, basic_variable'
from_schema: OAEDataManagementProtocol
is_a: BaseVariable
slot_usage:
  units:
    name: units
    required: true
attributes:
  dataset_variable_name_qc_flag:
    name: dataset_variable_name_qc_flag
    description: If applicable, the column header name used for the quality control
      flag corresponding to this variable.
    title: Dataset variable name (Quality Flag)
    from_schema: Variable
    rank: 1000
    domain_of:
    - Variable
    range: string
  dataset_variable_name_raw:
    name: dataset_variable_name_raw
    description: If applicable, the column header name used for the raw data corresponding
      to this variable.
    title: Dataset variable name (raw)
    from_schema: Variable
    rank: 1000
    domain_of:
    - Variable
    range: string
  method_reference:
    name: method_reference
    description: Citation for the method used.
    title: Method Reference
    from_schema: Variable
    domain_of:
    - Calibration
    - Variable
    range: string
  measurement_researcher:
    name: measurement_researcher
    description: The name of the PI whose research team measured or derived this parameter.
    title: Researcher who measured the variable
    from_schema: Variable
    rank: 1000
    domain_of:
    - Variable
    range: Person
  other_detailed_information:
    name: other_detailed_information
    description: Any additional information about this variable.
    title: Other Detailed Information
    from_schema: Variable
    rank: 1000
    domain_of:
    - Variable
    range: string

Induced

name: Variable
description: 'Base class for all variable types. Contains common identification and
  description fields shared by all variables. Reference: OAPMetadata XSD variables.xsd
  - variable, basic_variable'
from_schema: OAEDataManagementProtocol
is_a: BaseVariable
slot_usage:
  units:
    name: units
    required: true
attributes:
  dataset_variable_name_qc_flag:
    name: dataset_variable_name_qc_flag
    description: If applicable, the column header name used for the quality control
      flag corresponding to this variable.
    title: Dataset variable name (Quality Flag)
    from_schema: Variable
    rank: 1000
    alias: dataset_variable_name_qc_flag
    owner: Variable
    domain_of:
    - Variable
    range: string
  dataset_variable_name_raw:
    name: dataset_variable_name_raw
    description: If applicable, the column header name used for the raw data corresponding
      to this variable.
    title: Dataset variable name (raw)
    from_schema: Variable
    rank: 1000
    alias: dataset_variable_name_raw
    owner: Variable
    domain_of:
    - Variable
    range: string
  method_reference:
    name: method_reference
    description: Citation for the method used.
    title: Method Reference
    from_schema: Variable
    alias: method_reference
    owner: Variable
    domain_of:
    - Calibration
    - Variable
    range: string
  measurement_researcher:
    name: measurement_researcher
    description: The name of the PI whose research team measured or derived this parameter.
    title: Researcher who measured the variable
    from_schema: Variable
    rank: 1000
    alias: measurement_researcher
    owner: Variable
    domain_of:
    - Variable
    range: Person
  other_detailed_information:
    name: other_detailed_information
    description: Any additional information about this variable.
    title: Other Detailed Information
    from_schema: Variable
    rank: 1000
    alias: other_detailed_information
    owner: Variable
    domain_of:
    - Variable
    range: string
  units:
    name: units
    description: Unit of measurement for this variable.
    title: Unit
    from_schema: OAEDataManagementProtocol
    rank: 1000
    alias: units
    owner: Variable
    domain_of:
    - BaseVariable
    range: string
    required: true
  standard_identifier:
    name: standard_identifier
    from_schema: Variable
    rank: 1000
    alias: standard_identifier
    owner: Variable
    domain_of:
    - BaseVariable
    range: VocabularyItemReference
  dataset_variable_name:
    name: dataset_variable_name
    description: The name for the variable as it is identified in the dataset data
      file. This could be the column header in a CSV or the variable name in a NetCDF
      file. Standard common recommended column header names can be found in protocol
      documentation  [here](https://www.carbontosea.org/oae-data-protocol/1-0-0/#column-header-name).
    title: Dataset variable name
    from_schema: Variable
    rank: 1000
    alias: dataset_variable_name
    owner: Variable
    domain_of:
    - BaseVariable
    range: string
    required: true
  long_name:
    name: long_name
    description: Full descriptive name of the variable.
    title: Variable full name
    from_schema: Variable
    rank: 1000
    alias: long_name
    owner: Variable
    domain_of:
    - BaseVariable
    range: string
    required: true