Class: SampleProcessing
URI: ak_schema:SampleProcessing
classDiagram
class SampleProcessing
click SampleProcessing href "../SampleProcessing"
AIRRStandards <|-- SampleProcessing
click AIRRStandards href "../AIRRStandards"
SampleProcessing : anatomic_site
SampleProcessing : biomaterial_provider
SampleProcessing : cell_isolation
SampleProcessing : cell_number
SampleProcessing : cell_phenotype
SampleProcessing : cell_processing_protocol
SampleProcessing : cell_quality
SampleProcessing : cell_species
SampleProcessing --> "0..1" CellSpeciesOntology : cell_species
click CellSpeciesOntology href "../CellSpeciesOntology"
SampleProcessing : cell_storage
SampleProcessing : cell_subset
SampleProcessing --> "0..1" CellSubsetOntology : cell_subset
click CellSubsetOntology href "../CellSubsetOntology"
SampleProcessing : cells_per_reaction
SampleProcessing : collection_time_point_reference
SampleProcessing : collection_time_point_relative
SampleProcessing : collection_time_point_relative_unit
SampleProcessing --> "0..1" CollectionTimePointRelativeUnitOntology : collection_time_point_relative_unit
click CollectionTimePointRelativeUnitOntology href "../CollectionTimePointRelativeUnitOntology"
SampleProcessing : complete_sequences
SampleProcessing --> "0..1" CompleteSequencesEnum : complete_sequences
click CompleteSequencesEnum href "../CompleteSequencesEnum"
SampleProcessing : disease_state_sample
SampleProcessing : library_generation_kit_version
SampleProcessing : library_generation_method
SampleProcessing --> "0..1" LibraryGenerationMethodEnum : library_generation_method
click LibraryGenerationMethodEnum href "../LibraryGenerationMethodEnum"
SampleProcessing : library_generation_protocol
SampleProcessing : pcr_target
SampleProcessing --> "*" PCRTarget : pcr_target
click PCRTarget href "../PCRTarget"
SampleProcessing : physical_linkage
SampleProcessing --> "0..1" PhysicalLinkageEnum : physical_linkage
click PhysicalLinkageEnum href "../PhysicalLinkageEnum"
SampleProcessing : sample_id
SampleProcessing : sample_processing_id
SampleProcessing : sample_type
SampleProcessing : sequencing_facility
SampleProcessing : sequencing_files
SampleProcessing --> "0..1" SequencingData : sequencing_files
click SequencingData href "../SequencingData"
SampleProcessing : sequencing_kit
SampleProcessing : sequencing_platform
SampleProcessing : sequencing_run_date
SampleProcessing : sequencing_run_id
SampleProcessing : single_cell
SampleProcessing : template_amount
SampleProcessing : template_amount_unit
SampleProcessing --> "0..1" TemplateAmountUnitOntology : template_amount_unit
click TemplateAmountUnitOntology href "../TemplateAmountUnitOntology"
SampleProcessing : template_class
SampleProcessing --> "0..1" TemplateClassEnum : template_class
click TemplateClassEnum href "../TemplateClassEnum"
SampleProcessing : template_quality
SampleProcessing : tissue
SampleProcessing --> "0..1" TissueOntology : tissue
click TissueOntology href "../TissueOntology"
SampleProcessing : tissue_processing
SampleProcessing : total_reads_passing_qc_filter
Inheritance
- AIRRStandards
- SampleProcessing
Slots
Name | Cardinality and Range | Description | Inheritance |
---|---|---|---|
sample_processing_id | 0..1 String |
direct | |
sample_id | 0..1 String |
Sample ID assigned by submitter, unique within study | direct |
sample_type | 0..1 String |
The way the sample was obtained, e | direct |
tissue | 0..1 TissueOntology |
The actual tissue sampled, e | direct |
anatomic_site | 0..1 String |
The anatomic location of the tissue, e | direct |
disease_state_sample | 0..1 String |
Histopathologic evaluation of the sample | direct |
collection_time_point_relative | 0..1 Float |
Time point at which sample was taken, relative to Collection time event |
direct |
collection_time_point_relative_unit | 0..1 CollectionTimePointRelativeUnitOntology |
Unit of Sample collection time | direct |
collection_time_point_reference | 0..1 String |
Event in the study schedule to which Sample collection time relates to |
direct |
biomaterial_provider | 0..1 String |
Name and address of the entity providing the sample | direct |
tissue_processing | 0..1 String |
Enzymatic digestion and/or physical methods used to isolate cells from sample | direct |
cell_subset | 0..1 CellSubsetOntology |
Commonly-used designation of isolated cell population | direct |
cell_phenotype | 0..1 String |
List of cellular markers and their expression levels used to isolate the cell... | direct |
cell_species | 0..1 CellSpeciesOntology |
Binomial designation of the species from which the analyzed cells originate | direct |
single_cell | 0..1 Boolean |
TRUE if single cells were isolated into separate compartments | direct |
cell_number | 0..1 Integer |
Total number of cells that went into the experiment | direct |
cells_per_reaction | 0..1 Integer |
Number of cells for each biological replicate | direct |
cell_storage | 0..1 Boolean |
TRUE if cells were cryo-preserved between isolation and further processing | direct |
cell_quality | 0..1 String |
Relative amount of viable cells after preparation and (if applicable) thawing | direct |
cell_isolation | 0..1 String |
Description of the procedure used for marker-based isolation or enrich cells | direct |
cell_processing_protocol | 0..1 String |
Description of the methods applied to the sample including cell preparation/ ... | direct |
template_class | 0..1 TemplateClassEnum |
The class of nucleic acid that was used as primary starting material for the ... | direct |
template_quality | 0..1 String |
Description and results of the quality control performed on the template mate... | direct |
template_amount | 0..1 Float |
Amount of template that went into the process | direct |
template_amount_unit | 0..1 TemplateAmountUnitOntology |
Unit of template amount | direct |
library_generation_method | 0..1 LibraryGenerationMethodEnum |
Generic type of library generation | direct |
library_generation_protocol | 0..1 String |
Description of processes applied to substrate to obtain a library that is rea... | direct |
library_generation_kit_version | 0..1 String |
When using a library generation protocol from a commercial provider, provide ... | direct |
pcr_target | * PCRTarget |
If a PCR step was performed that specifically targets the IG/TR loci, the tar... | direct |
complete_sequences | 0..1 CompleteSequencesEnum |
To be considered complete , the procedure used for library construction MUST... |
direct |
physical_linkage | 0..1 PhysicalLinkageEnum |
In case an experimental setup is used that physically links nucleic acids der... | direct |
sequencing_run_id | 0..1 String |
ID of sequencing run assigned by the sequencing facility | direct |
total_reads_passing_qc_filter | 0..1 Integer |
Number of usable reads for analysis | direct |
sequencing_platform | 0..1 String |
Designation of sequencing instrument used | direct |
sequencing_facility | 0..1 String |
Name and address of sequencing facility | direct |
sequencing_run_date | 0..1 Datetime |
Date of sequencing run | direct |
sequencing_kit | 0..1 String |
Name, manufacturer, order and lot numbers of sequencing kit | direct |
sequencing_files | 0..1 SequencingData |
Set of sequencing files produced by the sequencing run | direct |
Usages
used by | used in | type | used |
---|---|---|---|
Repertoire | sample | range | SampleProcessing |
Identifier and Mapping Information
Schema Source
- from schema: https://github.com/airr-knowledge/ak-schema
Mappings
Mapping Type | Mapped Value |
---|---|
self | ak_schema:SampleProcessing |
native | ak_schema:SampleProcessing |
LinkML Source
Direct
name: SampleProcessing
from_schema: https://github.com/airr-knowledge/ak-schema
is_a: AIRRStandards
slots:
- sample_processing_id
- sample_id
- sample_type
- tissue
- anatomic_site
- disease_state_sample
- collection_time_point_relative
- collection_time_point_relative_unit
- collection_time_point_reference
- biomaterial_provider
- tissue_processing
- cell_subset
- cell_phenotype
- cell_species
- single_cell
- cell_number
- cells_per_reaction
- cell_storage
- cell_quality
- cell_isolation
- cell_processing_protocol
- template_class
- template_quality
- template_amount
- template_amount_unit
- library_generation_method
- library_generation_protocol
- library_generation_kit_version
- pcr_target
- complete_sequences
- physical_linkage
- sequencing_run_id
- total_reads_passing_qc_filter
- sequencing_platform
- sequencing_facility
- sequencing_run_date
- sequencing_kit
- sequencing_files
Induced
name: SampleProcessing
from_schema: https://github.com/airr-knowledge/ak-schema
is_a: AIRRStandards
attributes:
sample_processing_id:
name: sample_processing_id
annotations:
nullable:
tag: nullable
value: true
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sample_processing_id
owner: SampleProcessing
domain_of:
- Rearrangement
- SampleProcessing
range: string
sample_id:
name: sample_id
annotations:
nullable:
tag: nullable
value: true
description: Sample ID assigned by submitter, unique within study. If possible,
a persistent sample ID linked to INSDC or similar repository study should be
used.
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sample_id
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
sample_type:
name: sample_type
annotations:
nullable:
tag: nullable
value: true
description: The way the sample was obtained, e.g. fine-needle aspirate, organ
harvest, peripheral venous puncture
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
slot_uri: rdf:type
alias: sample_type
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
tissue:
name: tissue
annotations:
nullable:
tag: nullable
value: true
description: The actual tissue sampled, e.g. lymph node, liver, peripheral blood
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: tissue
owner: SampleProcessing
domain_of:
- Specimen
- Sample
- SampleProcessing
range: TissueOntology
anatomic_site:
name: anatomic_site
annotations:
nullable:
tag: nullable
value: true
description: The anatomic location of the tissue, e.g. Inguinal, femur
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: anatomic_site
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
disease_state_sample:
name: disease_state_sample
annotations:
nullable:
tag: nullable
value: true
description: Histopathologic evaluation of the sample
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: disease_state_sample
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
collection_time_point_relative:
name: collection_time_point_relative
annotations:
nullable:
tag: nullable
value: true
description: Time point at which sample was taken, relative to `Collection time
event`
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: collection_time_point_relative
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: float
collection_time_point_relative_unit:
name: collection_time_point_relative_unit
annotations:
nullable:
tag: nullable
value: true
description: Unit of Sample collection time
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: collection_time_point_relative_unit
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: CollectionTimePointRelativeUnitOntology
collection_time_point_reference:
name: collection_time_point_reference
annotations:
nullable:
tag: nullable
value: true
description: Event in the study schedule to which `Sample collection time` relates
to
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: collection_time_point_reference
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
biomaterial_provider:
name: biomaterial_provider
annotations:
nullable:
tag: nullable
value: true
description: Name and address of the entity providing the sample
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: biomaterial_provider
owner: SampleProcessing
domain_of:
- Sample
- SampleProcessing
range: string
tissue_processing:
name: tissue_processing
annotations:
nullable:
tag: nullable
value: true
description: Enzymatic digestion and/or physical methods used to isolate cells
from sample
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: tissue_processing
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: string
cell_subset:
name: cell_subset
annotations:
nullable:
tag: nullable
value: true
description: Commonly-used designation of isolated cell population
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_subset
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: CellSubsetOntology
cell_phenotype:
name: cell_phenotype
annotations:
nullable:
tag: nullable
value: true
description: List of cellular markers and their expression levels used to isolate
the cell population
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_phenotype
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: string
cell_species:
name: cell_species
annotations:
nullable:
tag: nullable
value: true
description: Binomial designation of the species from which the analyzed cells
originate. Typically, this value should be identical to `species`, in which
case it SHOULD NOT be set explicitly. However, there are valid experimental
setups in which the two might differ, e.g., chimeric animal models. If set,
this key will overwrite the `species` information for all lower layers of the
schema.
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_species
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: CellSpeciesOntology
single_cell:
name: single_cell
annotations:
nullable:
tag: nullable
value: true
description: TRUE if single cells were isolated into separate compartments
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: single_cell
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: boolean
cell_number:
name: cell_number
annotations:
nullable:
tag: nullable
value: true
description: Total number of cells that went into the experiment
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_number
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: integer
cells_per_reaction:
name: cells_per_reaction
annotations:
nullable:
tag: nullable
value: true
description: Number of cells for each biological replicate
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cells_per_reaction
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: integer
cell_storage:
name: cell_storage
annotations:
nullable:
tag: nullable
value: true
description: TRUE if cells were cryo-preserved between isolation and further processing
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_storage
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: boolean
cell_quality:
name: cell_quality
annotations:
nullable:
tag: nullable
value: true
description: Relative amount of viable cells after preparation and (if applicable)
thawing
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_quality
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: string
cell_isolation:
name: cell_isolation
annotations:
nullable:
tag: nullable
value: true
description: Description of the procedure used for marker-based isolation or enrich
cells
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_isolation
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: string
cell_processing_protocol:
name: cell_processing_protocol
annotations:
nullable:
tag: nullable
value: true
description: Description of the methods applied to the sample including cell preparation/
isolation/enrichment and nucleic acid extraction. This should closely mirror
the Materials and methods section in the manuscript.
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: cell_processing_protocol
owner: SampleProcessing
domain_of:
- CellIsolationProcessing
- CellProcessing
- SampleProcessing
range: string
template_class:
name: template_class
annotations:
nullable:
tag: nullable
value: false
description: The class of nucleic acid that was used as primary starting material
for the following procedures
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: template_class
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: TemplateClassEnum
template_quality:
name: template_quality
annotations:
nullable:
tag: nullable
value: true
description: Description and results of the quality control performed on the template
material
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: template_quality
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: string
template_amount:
name: template_amount
annotations:
nullable:
tag: nullable
value: true
description: Amount of template that went into the process
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: template_amount
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: float
template_amount_unit:
name: template_amount_unit
annotations:
nullable:
tag: nullable
value: true
description: Unit of template amount
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: template_amount_unit
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: TemplateAmountUnitOntology
library_generation_method:
name: library_generation_method
annotations:
nullable:
tag: nullable
value: false
description: Generic type of library generation
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: library_generation_method
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: LibraryGenerationMethodEnum
library_generation_protocol:
name: library_generation_protocol
annotations:
nullable:
tag: nullable
value: true
description: Description of processes applied to substrate to obtain a library
that is ready for sequencing
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: library_generation_protocol
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: string
library_generation_kit_version:
name: library_generation_kit_version
annotations:
nullable:
tag: nullable
value: true
description: When using a library generation protocol from a commercial provider,
provide the protocol version number
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: library_generation_kit_version
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: string
pcr_target:
name: pcr_target
annotations:
nullable:
tag: nullable
value: false
description: If a PCR step was performed that specifically targets the IG/TR loci,
the target and primer locations need to be provided here. This field holds an
array of PCRTarget objects, so that multiplex PCR setups amplifying multiple
loci at the same time can be annotated using one record per locus. PCR setups
not targeting any specific locus must not annotate this field but select the
appropriate library_generation_method instead.
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: pcr_target
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: PCRTarget
multivalued: true
complete_sequences:
name: complete_sequences
annotations:
nullable:
tag: nullable
value: false
description: To be considered `complete`, the procedure used for library construction
MUST generate sequences that 1) include the first V gene codon that encodes
the mature polypeptide chain (i.e. after the leader sequence) and 2) include
the last complete codon of the J gene (i.e. 1 bp 5' of the J->C splice site)
and 3) provide sequence information for all positions between 1) and 2). To
be considered `complete & untemplated`, the sections of the sequences defined
in points 1) to 3) of the previous sentence MUST be untemplated, i.e. MUST NOT
overlap with the primers used in library preparation. `mixed` should only be
used if the procedure used for library construction will likely produce multiple
categories of sequences in the given experiment. It SHOULD NOT be used as a
replacement of a NULL value.
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: complete_sequences
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: CompleteSequencesEnum
physical_linkage:
name: physical_linkage
annotations:
nullable:
tag: nullable
value: false
description: In case an experimental setup is used that physically links nucleic
acids derived from distinct `Rearrangements` before library preparation, this
field describes the mode of that linkage. All `hetero_*` terms indicate that
in case of paired-read sequencing, the two reads should be expected to map to
distinct IG/TR loci. `*_head-head` refers to techniques that link the 5' ends
of transcripts in a single-cell context. `*_tail-head` refers to techniques
that link the 3' end of one transcript to the 5' end of another one in a single-cell
context. This term does not provide any information whether a continuous reading-frame
between the two is generated. `*_prelinked` refers to constructs in which the
linkage was already present on the DNA level (e.g. scFv).
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: physical_linkage
owner: SampleProcessing
domain_of:
- NucleicAcidProcessing
- SampleProcessing
range: PhysicalLinkageEnum
sequencing_run_id:
name: sequencing_run_id
annotations:
nullable:
tag: nullable
value: true
description: ID of sequencing run assigned by the sequencing facility
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_run_id
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: string
total_reads_passing_qc_filter:
name: total_reads_passing_qc_filter
annotations:
nullable:
tag: nullable
value: true
description: Number of usable reads for analysis
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: total_reads_passing_qc_filter
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: integer
sequencing_platform:
name: sequencing_platform
annotations:
nullable:
tag: nullable
value: true
description: Designation of sequencing instrument used
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_platform
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: string
sequencing_facility:
name: sequencing_facility
annotations:
nullable:
tag: nullable
value: true
description: Name and address of sequencing facility
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_facility
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: string
sequencing_run_date:
name: sequencing_run_date
annotations:
nullable:
tag: nullable
value: true
description: Date of sequencing run
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_run_date
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: datetime
sequencing_kit:
name: sequencing_kit
annotations:
nullable:
tag: nullable
value: true
description: Name, manufacturer, order and lot numbers of sequencing kit
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_kit
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: string
sequencing_files:
name: sequencing_files
annotations:
nullable:
tag: nullable
value: false
description: Set of sequencing files produced by the sequencing run
from_schema: https://github.com/airr-knowledge/ak-schema
rank: 1000
alias: sequencing_files
owner: SampleProcessing
domain_of:
- SequencingRun
- SampleProcessing
range: SequencingData