Skip to content

Class: Study

URI: ak_schema:Study

classDiagram class Study click Study href "../Study" AIRRStandards <|-- Study click AIRRStandards href "../AIRRStandards" Study : adc_publish_date Study : adc_update_date Study : collected_by Study : grants Study : inclusion_exclusion_criteria Study : keywords_study Study --> "*" KeywordsStudyEnum : keywords_study click KeywordsStudyEnum href "../KeywordsStudyEnum" Study : lab_address Study : lab_name Study : pub_ids Study : study_contact Study : study_description Study : study_id Study : study_title Study : study_type Study --> "0..1" StudyTypeOntology : study_type click StudyTypeOntology href "../StudyTypeOntology" Study : submitted_by

Inheritance

Slots

Name Cardinality and Range Description Inheritance
study_id 0..1
String
Unique ID assigned by study registry such as one of the International Nucleot... direct
study_title 0..1
String
Descriptive study title direct
study_type 0..1
StudyTypeOntology
Type of study design direct
study_description 0..1
String
Generic study description direct
inclusion_exclusion_criteria 0..1
String
List of criteria for inclusion/exclusion for the study direct
grants 0..1
String
Funding agencies and grant numbers direct
study_contact 0..1
String
Full contact information of the contact persons for this study This should in... direct
collected_by 0..1
String
Full contact information of the data collector, i direct
lab_name 0..1
String
direct
lab_address 0..1
String
direct
submitted_by 0..1
String
Full contact information of the data depositor, i direct
pub_ids 0..1
String
direct
keywords_study *
KeywordsStudyEnum
Keywords describing properties of one or more data sets in a study direct
adc_publish_date 0..1
Datetime
Date the study was first published in the AIRR Data Commons direct
adc_update_date 0..1
Datetime
Date the study data was updated in the AIRR Data Commons direct

Usages

used by used in type used
Repertoire study range Study

Identifier and Mapping Information

Schema Source

  • from schema: https://github.com/airr-knowledge/ak-schema

Mappings

Mapping Type Mapped Value
self ak_schema:Study
native ak_schema:Study

LinkML Source

Direct

name: Study
from_schema: https://github.com/airr-knowledge/ak-schema
is_a: AIRRStandards
slots:
- study_id
- study_title
- study_type
- study_description
- inclusion_exclusion_criteria
- grants
- study_contact
- collected_by
- lab_name
- lab_address
- submitted_by
- pub_ids
- keywords_study
- adc_publish_date
- adc_update_date

Induced

name: Study
from_schema: https://github.com/airr-knowledge/ak-schema
is_a: AIRRStandards
attributes:
  study_id:
    name: study_id
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Unique ID assigned by study registry such as one of the International
      Nucleotide Sequence Database Collaboration (INSDC) repositories.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: study_id
    owner: Study
    domain_of:
    - Study
    range: string
  study_title:
    name: study_title
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Descriptive study title
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: study_title
    owner: Study
    domain_of:
    - Study
    range: string
  study_type:
    name: study_type
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Type of study design
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    slot_uri: rdf:type
    alias: study_type
    owner: Study
    domain_of:
    - Study
    range: StudyTypeOntology
  study_description:
    name: study_description
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Generic study description
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: study_description
    owner: Study
    domain_of:
    - Study
    range: string
  inclusion_exclusion_criteria:
    name: inclusion_exclusion_criteria
    annotations:
      nullable:
        tag: nullable
        value: true
    description: List of criteria for inclusion/exclusion for the study
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: inclusion_exclusion_criteria
    owner: Study
    domain_of:
    - Investigation
    - Study
    range: string
  grants:
    name: grants
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Funding agencies and grant numbers
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: grants
    owner: Study
    domain_of:
    - Study
    range: string
  study_contact:
    name: study_contact
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Full contact information of the contact persons for this study This
      should include an e-mail address and a persistent identifier such as an ORCID
      ID.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: study_contact
    owner: Study
    domain_of:
    - Study
    range: string
  collected_by:
    name: collected_by
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Full contact information of the data collector, i.e. the person who
      is legally responsible for data collection and release. This should include
      an e-mail address and a persistent identifier such as an ORCID ID.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: collected_by
    owner: Study
    domain_of:
    - Study
    range: string
  lab_name:
    name: lab_name
    annotations:
      nullable:
        tag: nullable
        value: true
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: lab_name
    owner: Study
    domain_of:
    - GermlineSet
    - Study
    range: string
  lab_address:
    name: lab_address
    annotations:
      nullable:
        tag: nullable
        value: true
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: lab_address
    owner: Study
    domain_of:
    - AlleleDescription
    - GermlineSet
    - Study
    range: string
  submitted_by:
    name: submitted_by
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Full contact information of the data depositor, i.e., the person
      submitting the data to a repository. This should include an e-mail address and
      a persistent identifier such as an ORCID ID. This is supposed to be a short-lived
      and technical role until the submission is relased.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: submitted_by
    owner: Study
    domain_of:
    - Study
    range: string
  pub_ids:
    name: pub_ids
    annotations:
      nullable:
        tag: nullable
        value: true
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: pub_ids
    owner: Study
    domain_of:
    - GermlineSet
    - Study
    range: string
  keywords_study:
    name: keywords_study
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Keywords describing properties of one or more data sets in a study.
      "contains_schema" keywords indicate that the study contains data objects from
      the AIRR Schema of that type (Rearrangement, Clone, Cell, Receptor) while the
      other keywords indicate that the study design considers the type of data indicated
      (e.g. it is possible to have a study that "contains_paired_chain" but does not
      "contains_schema_cell").
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: keywords_study
    owner: Study
    domain_of:
    - Study
    range: KeywordsStudyEnum
    multivalued: true
  adc_publish_date:
    name: adc_publish_date
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Date the study was first published in the AIRR Data Commons.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: adc_publish_date
    owner: Study
    domain_of:
    - Study
    range: datetime
  adc_update_date:
    name: adc_update_date
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Date the study data was updated in the AIRR Data Commons.
    from_schema: https://github.com/airr-knowledge/ak-schema
    rank: 1000
    alias: adc_update_date
    owner: Study
    domain_of:
    - Study
    range: datetime