Class: CalibrationInformation

name: CalibrationInformation
description: A calibration object that is associated with a process.
from_schema: https://w3id.org/nmdc/nmdc
is_a: InformationObject
slots:
- calibration_object
- internal_calibration
- calibration_target
- calibration_standard
slot_usage:
  internal_calibration:
    name: internal_calibration
    required: true
  calibration_target:
    name: calibration_target
    required: true
  id:
    name: id
    structured_pattern:
      syntax: '{id_nmdc_prefix}:calib-{id_shoulder}-{id_blade}$'
      interpolated: true
class_uri: nmdc:CalibrationInformation
rules:
- preconditions:
    slot_conditions:
      calibration_target:
        name: calibration_target
        equals_string: retention_index
  postconditions:
    slot_conditions:
      calibration_standard:
        name: calibration_standard
        required: true
  description: If the calibration_target is retention_index, a calibration_standard
    is required.
  title: calibration_standard_if_rt
- preconditions:
    slot_conditions:
      internal_calibration:
        name: internal_calibration
        id_prefixes:
        - 'False'
  postconditions:
    slot_conditions:
      calibration_object:
        name: calibration_object
        required: true
  description: If internal_calibration is false, a calibration_object is required.
  title: calibration_object_if_not_internal_calibration

name: CalibrationInformation
description: A calibration object that is associated with a process.
from_schema: https://w3id.org/nmdc/nmdc
is_a: InformationObject
slot_usage:
  internal_calibration:
    name: internal_calibration
    required: true
  calibration_target:
    name: calibration_target
    required: true
  id:
    name: id
    structured_pattern:
      syntax: '{id_nmdc_prefix}:calib-{id_shoulder}-{id_blade}$'
      interpolated: true
attributes:
  calibration_object:
    name: calibration_object
    description: the file containing calibration data object
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: calibration_object
    owner: CalibrationInformation
    domain_of:
    - CalibrationInformation
    range: DataObject
    structured_pattern:
      syntax: '{id_nmdc_prefix}:dobj-{id_shoulder}-{id_blade}$'
      interpolated: true
  internal_calibration:
    name: internal_calibration
    description: whether internal calibration was used, if false, external calibration
      was used
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: internal_calibration
    owner: CalibrationInformation
    domain_of:
    - CalibrationInformation
    range: boolean
    required: true
  calibration_target:
    name: calibration_target
    description: the target measurement of the calibration
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: calibration_target
    owner: CalibrationInformation
    domain_of:
    - CalibrationInformation
    range: CalibrationTargetEnum
    required: true
  calibration_standard:
    name: calibration_standard
    description: the reference standard(s) used for calibration
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: calibration_standard
    owner: CalibrationInformation
    domain_of:
    - CalibrationInformation
    range: CalibrationStandardEnum
  id:
    name: id
    description: A unique identifier for a thing. Must be either a CURIE shorthand
      for a URI or a complete URI
    notes:
    - 'abstracted pattern: prefix:typecode-authshoulder-blade(.version)?(_seqsuffix)?'
    - a minimum length of 3 characters is suggested for typecodes, but 1 or 2 characters
      will be accepted
    - typecodes must correspond 1:1 to a class in the NMDC schema. this will be checked
      via per-class id slot usage assertions
    - minting authority shoulders should probably be enumerated and checked in the
      pattern
    examples:
    - value: nmdc:mgmag-00-x012.1_7_c1
      description: https://github.com/microbiomedata/nmdc-schema/pull/499#discussion_r1018499248
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    identifier: true
    alias: id
    owner: CalibrationInformation
    domain_of:
    - NamedThing
    range: uriorcurie
    required: true
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_\.]+:[a-zA-Z0-9_][a-zA-Z0-9_\-\/\.,]*$
    structured_pattern:
      syntax: '{id_nmdc_prefix}:calib-{id_shoulder}-{id_blade}$'
      interpolated: true
  name:
    name: name
    description: A human readable label for an entity
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: name
    owner: CalibrationInformation
    domain_of:
    - PersonValue
    - NamedThing
    - Protocol
    range: string
  description:
    name: description
    description: a human-readable description of a thing
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    slot_uri: dcterms:description
    alias: description
    owner: CalibrationInformation
    domain_of:
    - ImageValue
    - NamedThing
    range: string
  alternative_identifiers:
    name: alternative_identifiers
    description: A list of alternative identifiers for the entity.
    from_schema: https://w3id.org/nmdc/nmdc
    rank: 1000
    alias: alternative_identifiers
    owner: CalibrationInformation
    domain_of:
    - MetaboliteIdentification
    - NamedThing
    range: uriorcurie
    multivalued: true
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_\.]+:[a-zA-Z0-9_][a-zA-Z0-9_\-\/\.,\(\)\=\#]*$
  type:
    name: type
    description: the class_uri of the class that has been instantiated
    notes:
    - replaces legacy nmdc:type slot
    - makes it easier to read example data files
    - required for polymorphic MongoDB collections
    examples:
    - value: nmdc:Biosample
    - value: nmdc:Study
    from_schema: https://w3id.org/nmdc/nmdc
    see_also:
    - https://github.com/microbiomedata/nmdc-schema/issues/1048
    - https://github.com/microbiomedata/nmdc-schema/issues/1233
    - https://github.com/microbiomedata/nmdc-schema/issues/248
    rank: 1000
    slot_uri: rdf:type
    designates_type: true
    alias: type
    owner: CalibrationInformation
    domain_of:
    - EukEval
    - FunctionalAnnotationAggMember
    - PeptideQuantification
    - ProteinQuantification
    - MobilePhaseSegment
    - PortionOfSubstance
    - MagBin
    - MetaboliteIdentification
    - GenomeFeature
    - FunctionalAnnotation
    - AttributeValue
    - NamedThing
    - OntologyRelation
    - FailureCategorization
    - Protocol
    - CreditAssociation
    - Doi
    range: uriorcurie
    required: true
class_uri: nmdc:CalibrationInformation
rules:
- preconditions:
    slot_conditions:
      calibration_target:
        name: calibration_target
        equals_string: retention_index
  postconditions:
    slot_conditions:
      calibration_standard:
        name: calibration_standard
        required: true
  description: If the calibration_target is retention_index, a calibration_standard
    is required.
  title: calibration_standard_if_rt
- preconditions:
    slot_conditions:
      internal_calibration:
        name: internal_calibration
        id_prefixes:
        - 'False'
  postconditions:
    slot_conditions:
      calibration_object:
        name: calibration_object
        required: true
  description: If internal_calibration is false, a calibration_object is required.
  title: calibration_object_if_not_internal_calibration