Skip to content

Class: Receptor

Default Receptor description

URI: https://github.com/vdjserver/vdjserver-airr-schema/Receptor

 classDiagram
    class Receptor
    click Receptor href "../Receptor/"
      AIRRStandards <|-- Receptor
        click AIRRStandards href "../AIRRStandards/"

      Receptor : receptor_hash

      Receptor : receptor_id

      Receptor : receptor_ref

      Receptor : receptor_type





        Receptor --> "0..1" ReceptorTypeEnum : receptor_type
        click ReceptorTypeEnum href "../ReceptorTypeEnum/"



      Receptor : receptor_variable_domain_1_aa

      Receptor : receptor_variable_domain_1_locus





        Receptor --> "0..1" ReceptorVariableDomain1LocusEnum : receptor_variable_domain_1_locus
        click ReceptorVariableDomain1LocusEnum href "../ReceptorVariableDomain1LocusEnum/"



      Receptor : receptor_variable_domain_2_aa

      Receptor : receptor_variable_domain_2_locus





        Receptor --> "0..1" ReceptorVariableDomain2LocusEnum : receptor_variable_domain_2_locus
        click ReceptorVariableDomain2LocusEnum href "../ReceptorVariableDomain2LocusEnum/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
receptor_id 0..1
String		 Identifier for the Receptor object direct
receptor_hash 0..1
String		 The SHA256 hash of the receptor amino acid sequence, calculated on the concat... direct
receptor_type 0..1
ReceptorTypeEnum		 The top-level receptor type, either Immunoglobulin (Ig) or T Cell Receptor (T... direct
receptor_variable_domain_1_aa 0..1
String		 Complete amino acid sequence of the mature variable domain of the Ig heavy, T... direct
receptor_variable_domain_1_locus 0..1
ReceptorVariableDomain1LocusEnum		 Locus from which the variable domain in receptor_variable_domain_1_aa origina... direct
receptor_variable_domain_2_aa 0..1
String		 Complete amino acid sequence of the mature variable domain of the Ig light, T... direct
receptor_variable_domain_2_locus 0..1
ReceptorVariableDomain2LocusEnum		 Locus from which the variable domain in receptor_variable_domain_2_aa origina... direct
receptor_ref *
String		 Array of receptor identifiers defined for the Receptor object direct

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self https://github.com/vdjserver/vdjserver-airr-schema/Receptor
native https://github.com/vdjserver/vdjserver-airr-schema/Receptor

LinkML Source

Direct

name: Receptor
description: Default Receptor description
from_schema: https://github.com/vdjserver/vdjserver-airr-schema
is_a: AIRRStandards
slots:
- receptor_id
- receptor_hash
- receptor_type
- receptor_variable_domain_1_aa
- receptor_variable_domain_1_locus
- receptor_variable_domain_2_aa
- receptor_variable_domain_2_locus
- receptor_ref

Induced

name: Receptor
description: Default Receptor description
from_schema: https://github.com/vdjserver/vdjserver-airr-schema
is_a: AIRRStandards
attributes:
  receptor_id:
    name: receptor_id
    annotations:
      nullable:
        tag: nullable
        value: false
    description: Identifier for the Receptor object. This identifier must be unique
      within  a given study, but it is recommended that it be a universally unique
      record locator to enable database applications.
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: string
  receptor_hash:
    name: receptor_hash
    annotations:
      nullable:
        tag: nullable
        value: false
    description: The SHA256 hash of the receptor amino acid sequence, calculated on
      the concatenated ``receptor_variable_domain_*_aa`` sequences and represented
      as base16-encoded string.
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: string
  receptor_type:
    name: receptor_type
    annotations:
      nullable:
        tag: nullable
        value: false
    description: The top-level receptor type, either Immunoglobulin (Ig) or T Cell
      Receptor (TCR).
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    slot_uri: rdf:type
    owner: Receptor
    domain_of:
    - Receptor
    range: ReceptorTypeEnum
  receptor_variable_domain_1_aa:
    name: receptor_variable_domain_1_aa
    annotations:
      nullable:
        tag: nullable
        value: false
    description: Complete amino acid sequence of the mature variable domain of the
      Ig heavy, TCR beta or TCR delta chain. The mature variable domain is defined
      as encompassing all AA from and including first AA after the the signal peptide
      to and including the last AA that is completely encoded by the J gene.
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: string
  receptor_variable_domain_1_locus:
    name: receptor_variable_domain_1_locus
    annotations:
      nullable:
        tag: nullable
        value: false
    description: Locus from which the variable domain in receptor_variable_domain_1_aa
      originates
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: ReceptorVariableDomain1LocusEnum
  receptor_variable_domain_2_aa:
    name: receptor_variable_domain_2_aa
    annotations:
      nullable:
        tag: nullable
        value: false
    description: Complete amino acid sequence of the mature variable domain of the
      Ig light, TCR alpha or TCR gamma chain. The mature variable domain is defined
      as encompassing all AA from and including first AA after the the signal peptide
      to and including the last AA that is completely encoded by the J gene.
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: string
  receptor_variable_domain_2_locus:
    name: receptor_variable_domain_2_locus
    annotations:
      nullable:
        tag: nullable
        value: false
    description: Locus from which the variable domain in receptor_variable_domain_2_aa
      originates
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: ReceptorVariableDomain2LocusEnum
  receptor_ref:
    name: receptor_ref
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Array of receptor identifiers defined for the Receptor object
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: Receptor
    domain_of:
    - Receptor
    range: string
    multivalued: true