Class: CalculatedVariable
Variable that is calculated or derived from other variables.
classDiagram
class CalculatedVariable
click CalculatedVariable href "../CalculatedVariable"
QCFields <|-- CalculatedVariable
click QCFields href "../QCFields"
Variable <|-- CalculatedVariable
click Variable href "../Variable"
CalculatedVariable : calculation_method_and_parameters
CalculatedVariable : dataset_variable_name
CalculatedVariable : dataset_variable_name_qc_flag
CalculatedVariable : dataset_variable_name_raw
CalculatedVariable : genesis
CalculatedVariable --> "1" GenesisType : genesis
click GenesisType href "../GenesisType"
CalculatedVariable : long_name
CalculatedVariable : measurement_researcher
CalculatedVariable --> "0..1" Person : measurement_researcher
click Person href "../Person"
CalculatedVariable : method_reference
CalculatedVariable : missing_value_indicators
CalculatedVariable : other_detailed_information
CalculatedVariable : qc_researcher
CalculatedVariable --> "0..1" Person : qc_researcher
click Person href "../Person"
CalculatedVariable : qc_researcher_institution
CalculatedVariable : qc_steps_taken
CalculatedVariable : standard_identifier
CalculatedVariable --> "0..1" VocabularyItemReference : standard_identifier
click VocabularyItemReference href "../VocabularyItemReference"
CalculatedVariable : uncertainty
CalculatedVariable : uncertainty_definition
CalculatedVariable : units
Inheritance
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| genesis | 1 GenesisType |
direct | |
| calculation_method_and_parameters | 1 String |
Information about how the variable was calculated and the parameters used in ... | direct |
| qc_steps_taken | 0..1 String |
Describe what QC steps have been taken to improve the quality of the data (e | QCFields |
| uncertainty | 0..1 String |
It is recommended to provide uncertainty for each data point in the data file | QCFields |
| uncertainty_definition | 0..1 String |
A description of the uncertainties involved in this method | QCFields |
| missing_value_indicators | 0..1 String |
The indicator used to represent missing values in the data file, e | QCFields |
| qc_researcher | 0..1 Person |
The name of the PI whose research team QCed this parameter | QCFields |
| qc_researcher_institution | 0..1 String |
The institution of the PI whose research team QCed this parameter | QCFields |
| dataset_variable_name_qc_flag | 0..1 String |
If applicable, the column header name used for the quality control flag corre... | Variable |
| dataset_variable_name_raw | 0..1 String |
If applicable, the column header name used for the raw data corresponding to ... | Variable |
| method_reference | 0..1 String |
Citation for the method used | Variable |
| measurement_researcher | 0..1 Person |
The name of the PI whose research team measured or derived this parameter | Variable |
| other_detailed_information | 0..1 String |
Any additional information about this variable | Variable |
| 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 |
Identifier and Mapping Information
Schema Source
- from schema: OAEDataManagementProtocol
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | oae:CalculatedVariable |
| native | oae:CalculatedVariable |
LinkML Source
Direct
name: CalculatedVariable
description: Variable that is calculated or derived from other variables.
from_schema: OAEDataManagementProtocol
is_a: Variable
mixins:
- QCFields
attributes:
genesis:
name: genesis
from_schema: Variable
domain_of:
- ObservedPropertyVariable
- CalculatedVariable
range: GenesisType
required: true
calculation_method_and_parameters:
name: calculation_method_and_parameters
description: 'Information about how the variable was calculated and the parameters
used in calculation, e.g.: Calculation software = CO2SYSv1 (MATLAB) Input variables
= pH and DIC (column header names ''ph_t_insitu'' and ''dic'' in associated
dataset file) Additional information = the dissociation constants of Lueker
et al., 2000 for carbonic acid, etc.'
title: Calculated Method And Parameters
from_schema: Variable
rank: 1000
domain_of:
- CalculatedVariable
range: string
required: true
Induced
name: CalculatedVariable
description: Variable that is calculated or derived from other variables.
from_schema: OAEDataManagementProtocol
is_a: Variable
mixins:
- QCFields
attributes:
genesis:
name: genesis
from_schema: Variable
alias: genesis
owner: CalculatedVariable
domain_of:
- ObservedPropertyVariable
- CalculatedVariable
range: GenesisType
required: true
calculation_method_and_parameters:
name: calculation_method_and_parameters
description: 'Information about how the variable was calculated and the parameters
used in calculation, e.g.: Calculation software = CO2SYSv1 (MATLAB) Input variables
= pH and DIC (column header names ''ph_t_insitu'' and ''dic'' in associated
dataset file) Additional information = the dissociation constants of Lueker
et al., 2000 for carbonic acid, etc.'
title: Calculated Method And Parameters
from_schema: Variable
rank: 1000
alias: calculation_method_and_parameters
owner: CalculatedVariable
domain_of:
- CalculatedVariable
range: string
required: true
qc_steps_taken:
name: qc_steps_taken
description: 'Describe what QC steps have been taken to improve the quality of
the data (e.g., DOI, software and settings used, outlier removal, etc.).
If quality control procedures are described in a separate document uploaded
with the data, provide the name of the document here.'
title: QC steps taken
from_schema: OAEDataManagementProtocol
rank: 1000
alias: qc_steps_taken
owner: CalculatedVariable
domain_of:
- QCFields
range: string
uncertainty:
name: uncertainty
description: 'It is recommended to provide uncertainty for each data point in
the data file. Else provide a single value representative of the dataset.
If uncertainty is provided as a variable, please list the column header name
here.'
title: Uncertainty
from_schema: OAEDataManagementProtocol
rank: 1000
alias: uncertainty
owner: CalculatedVariable
domain_of:
- StandardGas
- CO2GasDetector
- QCFields
range: string
uncertainty_definition:
name: uncertainty_definition
description: A description of the uncertainties involved in this method.
title: How was the uncertainty defined
from_schema: OAEDataManagementProtocol
rank: 1000
alias: uncertainty_definition
owner: CalculatedVariable
domain_of:
- QCFields
range: string
missing_value_indicators:
name: missing_value_indicators
description: The indicator used to represent missing values in the data file,
e.g., -999, NaN, etc.
title: Missing value indicators
from_schema: OAEDataManagementProtocol
rank: 1000
alias: missing_value_indicators
owner: CalculatedVariable
domain_of:
- QCFields
range: string
qc_researcher:
name: qc_researcher
description: The name of the PI whose research team QCed this parameter.
title: Researcher who QCed this variable
from_schema: Variable
rank: 1000
alias: qc_researcher
owner: CalculatedVariable
domain_of:
- QCFields
range: Person
qc_researcher_institution:
name: qc_researcher_institution
description: The institution of the PI whose research team QCed this parameter.
title: QC Researcher Institution
from_schema: Variable
rank: 1000
alias: qc_researcher_institution
owner: CalculatedVariable
domain_of:
- QCFields
range: string
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: CalculatedVariable
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: CalculatedVariable
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: CalculatedVariable
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: CalculatedVariable
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: CalculatedVariable
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: CalculatedVariable
domain_of:
- BaseVariable
range: string
required: true
standard_identifier:
name: standard_identifier
from_schema: Variable
rank: 1000
alias: standard_identifier
owner: CalculatedVariable
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: CalculatedVariable
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: CalculatedVariable
domain_of:
- BaseVariable
range: string
required: true