Skip to content

VDJServer AIRR Schema

LinkML representation of AIRR Standards 2.0 for VDJServer data modeling.

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

Name: vdjserver-airr-schema

Classes

Class Description
AIRRStandards An object directly converted from the AIRR schema
        AIRRRepertoire VDJServer extension of the AIRR Repertoire object
        AlleleDescription Details of a putative or confirmed Ig receptor gene/allele inferred from one ...
        Cell Default Cell description
        CellProcessing Default CellProcessing description
        Clone Default Clone description
        Contributor Individual whose contribution to this work should be acknowledged
        ContributorContribution Default ContributorContribution description
        DataFile VDJServer DataFile which is an extension of the AIRR DataFile object
        DataProcessing Default DataProcessing description
        DeletedGene Default DeletedGene description
        Diagnosis Default Diagnosis description
        DocumentedAllele Default DocumentedAllele description
        Expression Default Expression description
        Genotype Default Genotype description
        GenotypeSet Default GenotypeSet description
        GermlineSet A germline object set bringing together multiple AlleleDescriptions from the ...
        MHCAllele Default MHCAllele description
        MHCGenotype Default MHCGenotype description
        MHCGenotypeSet Default MHCGenotypeSet description
        Node Default Node description
        NucleicAcidProcessing Default NucleicAcidProcessing description
        PCRTarget Default PCRTarget description
        PhysicalQuantity A physical quantity from a measurement or observation
        Project VDJServer project which is an extension of the VDJServer Study object
        Reactivity Default Reactivity description
        RearrangedSequence Details of a directly observed rearranged sequence or an inference from rearr...
        Rearrangement Default Rearrangement description
        Receptor Default Receptor description
        Repertoire Default Repertoire description
        RepertoireFilter Default RepertoireFilter description
        RepertoireGroup Default RepertoireGroup description
        Sample Default Sample description
        SampleProcessing Default SampleProcessing description
        SequenceDelineationV Delineation of a V-gene in a particular system
        SequencingData Default SequencingData description
        SequencingRun Default SequencingRun description
        Study Default Study description
        Subject Default Subject description
        SubjectGenotype Default SubjectGenotype description
        TimeInterval Time range or interval for a measurement, observation or action
        TimePoint Time point at which an observation or other action was performed
        TimeQuantity A time quantity
        UndocumentedAllele Default UndocumentedAllele description
        UnrearrangedSequence Details of an unrearranged sequence contributing support for a gene or allele
BodyDetails
NotificationDetails Query status notification URL
PermissionDetails Default PermissionDetails description
StudyDetails Default StudyDetails description
SubjectDetails Default SubjectDetails description
VDJServerStandards An object directly converted from the VDJServer schema
        ADCAsyncQuery VDJServer object to represent an ADC asynchronous query
        ADCDownloadCache ADC download cache status
        ADCDownloadCacheRepertoire ADC download cache status for a repertoire within a study
        ADCDownloadCacheStudy ADC download cache status for a study in a repository
        ADCProjectLoad ADC project load
        ADCQueryFilter Query Filter Expression for the ADC API
        ADCRearrangementLoad ADC rearrangement load
        ADCRepository VDJServer object to represent an ADC repository, this includes VDJServer
        ADCRepositorySet Set of ADC repositories
        ADCRepositoryUpdateRequest API request object
        AnalysisProperties Analysis Properties
                AnalysisDocument Analysis workflow document
                        AnalysisRequest Request execution of an analysis workflow
        BasicResponse Basic response object
        CommonExtension VDJServer common extension properties
                RepertoireExtension Default RepertoireExtension description
                StudyExtension Default StudyExtension description
                        ProjectExtension Default ProjectExtension description
        DataFileExtension Default DataFileExtension description
        Feedback User feedback
        FeedbackRequest Feedback message
        FilePostitRequest Postit request for file
        ProjectFile VDJServer project files
                ProjectJobFile VDJServer files generated from jobs
        ProjectJob Job information associated with a VDJServer project
        ProjectPermission User permissions on project and its associated objects
        ProvDocument PROV document
        Recaptcha Google recaptcha response
        StatisticsCache Statistics cache status
        StatisticsCacheRepertoire Statistics cache status for a repertoire within a study
        StatisticsCacheStudy Statistics cache status for a study in a repository
        TapisMetaObject Tapis Meta API object
                ADCAsyncQueryMeta Tapis Meta object
                ADCDownloadCacheMeta Tapis Meta object
                ADCDownloadCacheRepertoireMeta Tapis Meta object
                ADCDownloadCacheStudyMeta Tapis Meta object
                ADCProjectLoadMeta Tapis Meta object
                ADCRearrangementLoadMeta Tapis Meta object
                ADCRepositorySetMeta Tapis Meta object
                AnalysisDocumentMeta Tapis Meta object for a VDJServer analysis document
                DataProcessingMeta Tapis Meta object for a VDJServer data processing
                DeletedFileMeta Tapis Meta object for a VDJServer deleted project file
                FeedbackMeta Tapis Meta object for VDJServer user feedback
                PrivateProjectMeta Tapis Meta object for a VDJServer private project
                        ArchivedProjectMeta Tapis Meta object for a VDJServer archived project
                ProjectFileMeta Tapis Meta object for a VDJServer project file
                ProjectJobFileMeta Tapis Meta object for a VDJServer project job file
                ProjectJobMeta Tapis Meta object for a VDJServer project job
                PublicProjectMeta Tapis Meta object for a VDJServer public project
                RepertoireGroupMeta Tapis Meta object for a VDJServer repertoire group
                RepertoireMeta VDJServer Repertoire in normal form, just vdjserver uuids link them
                SampleProcessingMeta Tapis Meta object for a VDJServer sample processing
                StatisticsCacheMeta Tapis Meta object
                StatisticsCacheRepertoireMeta Tapis Meta object
                StatisticsCacheStudyMeta Tapis Meta object
                SubjectMeta Tapis Meta object for a VDJServer subject
                UserAccountMeta Tapis Meta object for a VDJServer user account
                UserVerificationMeta Tapis Meta object for a VDJServer user verification
        TaskDocument Task document
        UserAccount User account and profile
        UserVerification User account verification
        VisualizationDocument Task document
        VisualizationRequest Request generation of data visualization

Slots

Slot Description
acknowledgements
activity Default slot description
adc List of production repositories
adc_publish_date Date the study was first published in the AIRR Data Commons
adc_update_date Date the study data was updated in the AIRR Data Commons
affiliation ROR of the contributor's primary affiliation
affiliation_department Additional information regarding the contributor's primary affiliation
age Age of subject expressed as a time interval
age_event Event in the study schedule to which Age refers
agent Default slot description
aliases Alternative names for this sequence
aligned_sequence Aligned sequence if this delineation provides an alignment
alignment_labels One string for each codon in the aligned_sequence indicating the label of tha...
allele_description_id Unique identifier of this AlleleDescription within the file
allele_description_ref Unique reference to the allele description, in standardized form (Repo:Label:...
allele_descriptions list of allele_descriptions in the germline set
allele_designation
allele_name Allele name as allocated by the inference pipeline
allele_similarity_cluster_designation ID of the similarity cluster used in this germline set, if designated
allele_similarity_cluster_member_id Membership ID of the allele within the similarity cluster, if a cluster is de...
allowedUses file path
analysis_provenance_id Identifier for machine-readable PROV model of analysis provenance
analysis_uuid Default slot description
anatomic_site The anatomic location of the tissue, e
ancestry_population Broad geographic origin of ancestry (continent)
antigen The substance against which the receptor was tested
antigen_source_species The species from which the antigen was isolated
antigen_type The type of antigen before processing by the immune system
archive_file
associationIds object associations
async_base_url Base ADC ASYNC API URL for repository
async_host Hostname for repository
base_url Base ADC URL for repository
biomaterial_provider Name and address of the entity providing the sample
body
c_alignment_end End position of the C gene alignment in both the sequence_alignment and germl...
c_alignment_start Start position of the C gene alignment in both the sequence_alignment and ger...
c_call Constant region gene with allele
c_cigar CIGAR string for the C gene alignment
c_germline_alignment Aligned constant region germline sequence spanning the same region as the c_s...
c_germline_alignment_aa Amino acid translation of the c_germline_aligment field
c_germline_end Alignment end position in the C gene reference sequence (1-based closed inter...
c_germline_start Alignment start position in the C gene reference sequence (1-based closed int...
c_identity Fractional identity for the C gene alignment
c_score Alignment score for the C gene alignment
c_sequence_alignment Aligned portion of query sequence assigned to the constant region, including ...
c_sequence_alignment_aa Amino acid translation of the c_sequence_alignment field
c_sequence_end End position of the C gene in the query sequence (1-based closed interval)
c_sequence_start Start position of the C gene in the query sequence (1-based closed interval)
c_support C gene alignment E-value, p-value, likelihood, probability or other similar m...
cdr1 Nucleotide sequence of the aligned CDR1 region
cdr1_aa Amino acid translation of the cdr1 field
cdr1_end
cdr1_start
cdr2 Nucleotide sequence of the aligned CDR2 region
cdr2_aa Amino acid translation of the cdr2 field
cdr2_end
cdr2_start
cdr3 Nucleotide sequence of the aligned CDR3 region
cdr3_aa Amino acid translation of the cdr3 field
cdr3_end CDR3 end position in the query sequence (1-based closed interval)
cdr3_start
cell_id
cell_isolation Description of the procedure used for marker-based isolation or enrich cells
cell_label Free text cell type annotation
cell_number Total number of cells that went into the experiment
cell_phenotype List of cellular markers and their expression levels used to isolate the cell...
cell_processing_protocol Description of the methods applied to the sample including cell preparation/ ...
cell_quality Relative amount of viable cells after preparation and (if applicable) thawing
cell_species Binomial designation of the species from which the analyzed cells originate
cell_storage TRUE if cells were cryo-preserved between isolation and further processing
cell_subset
cell_type Cell type (source)
cells_per_reaction Number of cells for each biological replicate
chromosome chromosome on which the gene is located
city Default slot description
clone_class Is this a single-chain clone or a cell-based clone?
clone_count Absolute count of the size (number of members) of this clone in the repertoir...
clone_id
coding_sequence Nucleotide sequence of the core coding region, such as the coding region of a...
collapsing_method The method used for combining multiple sequences from (4) into a single seque...
collection
collection_location Location where the sample was taken, preferred granularity is country-level
collection_time_point_relative Time point at which sample was taken, relative to label event
complete_sequences To be considered complete, the procedure used for library construction MUST...
complete_vdj True if the sequence alignment spans the entire V(D)J region
consensus_count Number of reads contributing to the UMI consensus or contig assembly for this...
contributions List of all roles the contributor had in a project
contributor_id Unique identifier of this contributor within the file
contributors List of individuals who contributed to the study
count_lrq_id Tapis LRQ identifier for estimated count of query result
country Default slot description
created object creation timestamp
curation
curational_tags Controlled-vocabulary tags applied to this description
d2_alignment_end End position of the second D gene alignment in both the sequence_alignment an...
d2_alignment_start Start position of the second D gene alignment in both the sequence_alignment ...
d2_call Second D gene with allele
d2_cigar CIGAR string for the second D gene alignment
d2_frame Numerical reading frame (1, 2, 3) of the second D gene in the query nucleotid...
d2_germline_alignment Aligned D gene germline sequence spanning the same region as the d2_sequence_...
d2_germline_alignment_aa Amino acid translation of the d2_germline_alignment field
d2_germline_end Alignment end position in the second D gene reference sequence (1-based close...
d2_germline_start Alignment start position in the second D gene reference sequence (1-based clo...
d2_identity Fractional identity for the second D gene alignment
d2_score Alignment score for the second D gene alignment
d2_sequence_alignment Aligned portion of query sequence assigned to the second D gene, including an...
d2_sequence_alignment_aa Amino acid translation of the d2_sequence_alignment field
d2_sequence_end End position of the second D gene in the query sequence (1-based closed inter...
d2_sequence_start Start position of the second D gene in the query sequence (1-based closed int...
d2_support D gene alignment E-value, p-value, likelihood, probability or other similar m...
d_alignment_end End position of the first or only D gene in both the sequence_alignment and g...
d_alignment_start Start position of the first or only D gene in both the sequence_alignment and...
d_call First or only D gene with allele
d_cigar CIGAR string for the first or only D gene alignment
d_frame Numerical reading frame (1, 2, 3) of the first or only D gene in the query nu...
d_germline_alignment Aligned D gene germline sequence spanning the same region as the d_sequence_a...
d_germline_alignment_aa Amino acid translation of the d_germline_alignment field
d_germline_end Alignment end position in the D gene reference sequence for the first or only...
d_germline_start Alignment start position in the D gene reference sequence for the first or on...
d_identity Fractional identity for the first or only D gene alignment
d_rs_3_prime_end End co-ordinate in the sequence field of the 3 prime D recombination site (D-...
d_rs_3_prime_start Start co-ordinate in the sequence field of the 3 prime D recombination site (...
d_rs_5_prime_end End co-ordinate in the sequence field of 5 the prime D recombination site (D-...
d_rs_5_prime_start Start co-ordinate in the sequence field of the 5 prime D recombination site (...
d_score Alignment score for the first or only D gene alignment
d_sequence_alignment Aligned portion of query sequence assigned to the first or only D gene, inclu...
d_sequence_alignment_aa Amino acid translation of the d_sequence_alignment field
d_sequence_end End position of the first or only D gene in the query sequence
d_sequence_start Start position of the first or only D gene in the query sequence
d_support D gene alignment E-value, p-value, likelihood, probability or other similar m...
data_processing List of Data Processing objects
data_processing_files Array of file names for data produced by this data processing
data_processing_id
data_processing_protocols General description of how QC is performed
degree Optional specification of the degree of contribution, should be used if multi...
deleted_genes Array of genes identified as being deleted in this genotype
delineation_scheme Name of the delineation scheme
deposited_version Version number of the sequence within the repository
derivation The class of nucleic acid that was used as primary starting material
diagnosis Diagnosis information for subject
diagnosis_timepoint Time point for the diagnosis
disable Disable the repository
disableJobEmail Default slot description
disablePublishEmail Default slot description
disableUserEmail Default slot description
disease_diagnosis Diagnosis of subject
disease_length Time duration between initial diagnosis and current intervention
disease_stage Stage of disease at current intervention
disease_state_sample Histopathologic evaluation of the sample
displayName Default slot description
documented_alleles List of alleles documented in reference set(s)
download_cache_id
download_url
duplicate_count Copy number or number of duplicate observations for the query sequence
email Default slot description
enable_cache
enable_statistics_cache Statistics cache enable/disable for the repository
endpoint API endpoint for query
entity Default slot description
estimated_count Estimated count of query result
ethnicity Ethnic group of subject (defined as cultural/language-based membership)
expression_id Identifier for the Expression object
feedback message content
feedbackMessage Default slot description
file_type File format for the raw reads or sequences
filename File name for the raw reads or sequences
fileType Default slot description
filter A JSON object describing how this Repertoire was filtered using the same stru...
final_file Filename for final processed data to be downloaded by user
firstName Default slot description
forward_pcr_primer_target_location Position of the most distal nucleotide templated by the forward primer or pri...
functional True if the gene is functional, false if it is a pseudogene
fwr1 Nucleotide sequence of the aligned FWR1 region
fwr1_aa Amino acid translation of the fwr1 field
fwr1_end
fwr1_start
fwr2 Nucleotide sequence of the aligned FWR2 region
fwr2_aa Amino acid translation of the fwr2 field
fwr2_end
fwr2_start
fwr3 Nucleotide sequence of the aligned FWR3 region
fwr3_aa Amino acid translation of the fwr3 field
fwr3_end
fwr3_start
fwr4 Nucleotide sequence of the aligned FWR4 region
fwr4_aa Amino acid translation of the fwr4 field
fwr4_end FWR4 end position in the query sequence (1-based closed interval)
fwr4_start FWR4 start position in the query sequence (1-based closed interval)
g_recaptcha_response The recaptcha response
gene The MHC gene to which the described allele belongs
gene_designation Gene number or other identifier, as (and if) defined
gene_end Co-ordinate in the sequence field of the last gene-coding nucleotide in the c...
gene_start Co-ordinate in the sequence field of the first nucleotide in the coding_seque...
genotype Default genotype description
genotype_class_list List of Genotypes included in this Receptor Genotype Set
germline_alignment Assembled, aligned, full-length inferred germline sequence spanning the same ...
germline_alignment_aa Amino acid translation of the assembled germline sequence
germline_database Source of germline V(D)J genes with version number or date accessed
germline_set_id Unique identifier of the GermlineSet within this file
germline_set_name descriptive name of this germline set
germline_set_ref
gff_end Genomic co-ordinates of the end of the sequence of interest described in this...
gff_seqid Sequence (from the assembly) of a window including the gene and preferably al...
gff_start Genomic co-ordinates of the start of the sequence of interest described in th...
grants Funding agencies and grant numbers
immunogen Antigen, vaccine or drug applied to subject at this intervention
inclusion_exclusion_criteria List of criteria for inclusion/exclusion for the study
index_filename File name for the index file
index_length Read length in bases for the index file
inference_process Information on how the genotype was acquired
inference_type Type of inference(s) from which this gene sequence was inferred
inferred_ancestor Node_id string that acts as a key to the Node record for the inferred naive ...
intervention Description of intervention
is_cached
isAssociatedWith Default slot description
isAttributedTo Default slot description
isDerivedFrom Default slot description
isEmailVerified Default slot description
isGeneratedBy Default slot description
isLoaded
isVerified Default slot description
j_alignment_end End position of the J gene alignment in both the sequence_alignment and germl...
j_alignment_start Start position of the J gene alignment in both the sequence_alignment and ger...
j_call J gene with allele
j_cdr3_end In the case of a J-gene, the co-ordinate in the sequence field of the first n...
j_cigar CIGAR string for the J gene alignment
j_codon_frame Codon position of the first nucleotide in the 'coding_sequence' field
j_donor_splice Co-ordinate in the sequence field of the final 3' nucleotide of the J-REGION ...
j_frameshift True if the J gene in the query nucleotide sequence contains a translational ...
j_germline_alignment Aligned J gene germline sequence spanning the same region as the j_sequence_a...
j_germline_alignment_aa Amino acid translation of the j_germline_alignment field
j_germline_end Alignment end position in the J gene reference sequence (1-based closed inter...
j_germline_start Alignment start position in the J gene reference sequence (1-based closed int...
j_identity Fractional identity for the J gene alignment
j_rs_end End co-ordinate in the sequence field of J recombination site (J-genes only)
j_rs_start Start co-ordinate in the sequence field of J recombination site (J-genes only...
j_score Alignment score for the J gene alignment
j_sequence_alignment Aligned portion of query sequence assigned to the J gene, including any indel...
j_sequence_alignment_aa Amino acid translation of the j_sequence_alignment field
j_sequence_end End position of the J gene in the query sequence (1-based closed interval)
j_sequence_start Start position of the J gene in the query sequence (1-based closed interval)
j_support J gene alignment E-value, p-value, likelihood, probability or other similar m...
job_uuid Default slot description
jobs_submitted Flag indicating if statistics jobs are being run
jobUuid Default slot description
junction Junction region nucleotide sequence, where the junction is defined as the CDR...
junction_aa Amino acid translation of the junction
junction_aa_length Number of amino acids in the junction sequence
junction_length Number of nucleotides in the junction sequence
keywords VDJServer specific keywords
keywords_study Keywords describing properties of one or more data sets in a study
label
lastName Default slot description
lastUpdated object last update timestamp
leader_1_end End co-ordinate in the sequence field of L-PART1 (V-genes only)
leader_1_start Start co-ordinate in the sequence field of L-PART1 (V-genes only)
leader_2_end End co-ordinate in the sequence field of L-PART2 (V-genes only)
leader_2_start Start co-ordinate in the sequence field of L-PART2 (V-genes only)
library_generation_kit_version When using a library generation protocol from a commercial provider, provide ...
library_generation_method Generic type of library generation
library_generation_protocol Description of processes applied to substrate to obtain a library that is rea...
ligand_type Classification of ligand binding to the cell
link_type Relation between subject and linked_subjects, can be genetic or environment...
linked_subjects Subject ID to which Relation type refers
load_set Last rearrangement set that was loaded
location_birth Self-reported location of birth of the subject, preferred granularity is coun...
locus
locus_species Binomial designation of the species from which the locus originates
lrq_id Tapis LRQ identifier
medical_history Medical history of subject that is relevant to assess the course of disease a...
message
method Default slot description
mhc_allele_1 Allele designation of the MHC alpha chain
mhc_allele_2 Allele designation of the MHC class II beta chain or the invariant beta2-micr...
mhc_alleles List of MHC alleles of the indicated mhc_class identified in an individual
mhc_class
mhc_gene_1 The MHC gene to which the mhc_allele_1 belongs
mhc_gene_2 The MHC gene to which the mhc_allele_2 belongs
mhc_genotype_id A unique identifier for this MHCGenotype, assumed to be unique in the context...
mhc_genotype_list List of MHCGenotypes included in this set
mhc_genotype_set MHC genotype set for this subject
mhc_genotype_set_id A unique identifier for this MHCGenotypeSet
mhc_genotyping_method Information on how the genotype was determined
n1_length Number of untemplated nucleotides 5' of the first or only D gene alignment
n2_length Number of untemplated nucleotides 3' of the first or only D gene alignment
n3_length Number of untemplated nucleotides 3' of the second D gene alignment
name Full name of contributor
node_class Does this node contain a rearrangement of a cell?
node_id Identifier for the node
node_type Node type (source)
nodes List of Nodes that are members of this clone
notification Query status notification URL
np1 Nucleotide sequence of the combined N/P region between the V gene and first D...
np1_aa Amino acid translation of the np1 field
np1_length Number of nucleotides between the V gene and first D gene alignments or betwe...
np2 Nucleotide sequence of the combined N/P region between either the first D gen...
np2_aa Amino acid translation of the np2 field
np2_length Number of nucleotides between either the first D gene and J gene alignments o...
np3 Nucleotide sequence of the combined N/P region between the second D gene and ...
np3_aa Amino acid translation of the np3 field
np3_length Number of nucleotides between the second D gene and J gene alignments
observation_type The type of observation from which this sequence was drawn, such as direct se...
orcid_id ORCID identifier of the contributor
owner
p3d2_length Number of palindromic nucleotides 3' of the second D gene alignment
p3d_length Number of palindromic nucleotides 3' of the first or only D gene alignment
p3v_length Number of palindromic nucleotides 3' of the V gene alignment
p5d2_length Number of palindromic nucleotides 5' of the second D gene alignment
p5d_length Number of palindromic nucleotides 5' of the first or only D gene alignment
p5j_length Number of palindromic nucleotides 5' of the J gene alignment
paired_filename File name for the second file in paired-read sequencing
paired_read_direction Read direction for the second file in paired-read sequencing
paired_read_length Read length in bases for the second file in paired-read sequencing
paired_reads_assembly How paired end reads were assembled into a single receptor sequence
pairedReadMetadataUuid Default slot description
paralogs Gene symbols of any paralogs
password Default slot description
patch_no Genome assembly patch number in which this gene was determined
path
pcr_target If a PCR step was performed that specifically targets the IG/TR loci, the tar...
pcr_target_locus Designation of the target locus
peptide_end End position of the peptide within the reference protein sequence
peptide_sequence_aa The actual peptide sequence against which the receptor reactivity was measure...
peptide_start Start position of the peptide within the reference protein sequence
permission Default slot description
phasing Chromosomal phasing indicator
physical_linkage In case an experimental setup is used that physically links nucleic acids der...
physical_quantity Physical quantity
physical_unit Unit of physical quantity
postit_id Tapis postit identifier for download file
primary primary analysis for AIRR data processing
primary_annotation If true, indicates this is the primary or default data processing for the rep...
primer_match_cutoffs How primers were identified in the sequences, were they removed/masked/etc?
prior_therapies List of all relevant previous therapies applied to subject for treatment of `...
processing_stage Default slot description
productive True if the V(D)J sequence is predicted to be productive
project_uuid Default slot description
projectUuid
property Name of the property observed, typically a gene or antibody identifier (and l...
property_type Keyword describing the property type and detection method used to measure the...
pub_ids
quality The Sanger/Phred quality scores for assessment of sequence quality
quality_alignment Sanger/Phred quality scores for assessment of sequence_alignment quality
quality_thresholds How/if sequences were removed from (4) based on base quality scores
qualityScoreMetadataUuid Default slot description
race Racial group of subject (as defined by NIH)
raw_file Tapis file containing raw JSON data from LRQ query
reactivity_id
reactivity_method The methodology used to assess/classify reactivity
reactivity_readout Reactivity measurement read-out
reactivity_ref Comma separated list of CURIE identifiers of external reactivity records (e
reactivity_refs Array of cross references to external epitope reactivity records
reactivity_unit The unit of the measurement
reactivity_value The absolute (processed) value of the measurement
read read permission
read_direction Read direction for the raw reads or sequences
read_length Read length in bases for the first file in paired-read sequencing
readDirection Default slot description
readMetadataUuid Default slot description
rearranged_support Default rearranged_support description
rearrangement_type Rearrangement type (source)
rearrangementDataLoaded Flag to indicate if rearrangement data has finished loading into ADC
receptor_genotype_id A unique identifier within the file for this Receptor Genotype, typically gen...
receptor_genotype_set Immune receptor genotype set for this subject
receptor_genotype_set_id A unique identifier for this Receptor Genotype Set, typically generated by th...
receptor_hash The SHA256 hash of the receptor amino acid sequence, calculated on the concat...
receptor_id Identifier for the Receptor object
receptor_ref Array of receptor identifiers defined for the Receptor object
receptor_type The top-level receptor type, either Immunoglobulin (Ig) or T Cell Receptor (T...
receptor_variable_domain_1_aa Complete amino acid sequence of the mature variable domain of the Ig heavy, T...
receptor_variable_domain_1_locus Locus from which the variable domain in receptor_variable_domain_1_aa origina...
receptor_variable_domain_2_aa Complete amino acid sequence of the mature variable domain of the Ig light, T...
receptor_variable_domain_2_locus Locus from which the variable domain in receptor_variable_domain_2_aa origina...
receptors Array of receptor identifiers defined for the Receptor objects associated wit...
reference_set_ref Repository and list from which it was taken (issuer/name/version)
release_date Date of this release
release_description Brief descriptive notes of the reason for this release and the changes embodi...
release_version
repertoire_description
repertoire_group_description Repertoire group description
repertoire_group_id
repertoire_group_name Short display name for this repertoire group
repertoire_id
repertoire_name Short generic display name for the repertoire
repertoire_type Repertoire type (source)
repertoireMetadataLoaded Flag to indicate if repertoire data has finished loading into ADC
repertoires List of repertoires in this group with an associated description and time poi...
repository Default slot description
repository_id
repository_name
repository_ref Queryable id or accession number of the sequence published by the repository
repository_set Default slot description
rev_comp True if the alignment is on the opposite strand (reverse complemented) with r...
reverse_pcr_primer_target_location Position of the most proximal nucleotide templated by the reverse primer or p...
role Role according to CRediT taxonomy
sample List of Sample Processing objects
sample_id Sample ID assigned by submitter, unique within study
sample_processing_id
sample_type The way the sample was obtained, e
secondaryInputs Default slot description
seed_id sequence_id or cell_id of the seed sequence/cell
sequence
sequence_aa Amino acid translation of the query nucleotide sequence
sequence_alignment Aligned portion of query sequence, including any indel corrections or numberi...
sequence_alignment_aa Amino acid translation of the aligned query sequence
sequence_delineation_id Unique identifier of this SequenceDelineationV within the file
sequence_end End co-ordinate of the sequence detailed in this record, within the sequence ...
sequence_id
sequence_start Start co-ordinate of the sequence detailed in this record, within the sequenc...
sequence_type Sequence type (V, D, J, C)
sequencing_data_id Persistent identifier of raw data stored in an archive (e
sequencing_facility Name and address of sequencing facility
sequencing_files Set of sequencing files produced by the sequencing run
sequencing_kit Name, manufacturer, order and lot numbers of sequencing kit
sequencing_platform Designation of sequencing instrument used
sequencing_run_date Date of sequencing run
sequencing_run_id ID of sequencing run assigned by the sequencing facility
server_host Hostname for repository
sex Biological sex of subject
should_cache
shouldLoad Flag to indicate project should be loaded into ADC
showArchivedJobs Flag for archived jobs
showArchivedProjects Default slot description
single_cell TRUE if single cells were isolated into separate compartments
size Default slot description
software_versions Version number and / or date, include company pipelines
species Binomial designation of subject's species
species_subgroup Race, strain or other species subgroup to which this subject belongs
species_subgroup_type Default species_subgroup_type description
staging List of staging repositories
state Default slot description
statistics_job_id Tapis jobs identifier for statistics calculation
status Status of record, assumed active if the field is not present
status_message Status message
stop_codon True if the aligned sequence contains a stop codon
strain_name Non-human designation of the strain or breed of animal used
strand sense (+ or -)
study Study object
study_description Generic study description
study_group_description Designation of study arm to which the subject is assigned to
study_id Unique ID assigned by study registry such as one of the International Nucleot...
study_title Descriptive study title
study_type Type of study design
subgroup_designation Identifier of the gene subgroup or clade, as (and if) defined
subject Subject object
subject_id Subject ID assigned by submitter, unique within study
supports_async Repository supports AIRR ADC ASYNC API extension
synthetic TRUE for libraries in which the diversity has been synthetically generated (e
tags Default slot description
template_amount Amount of template that went into the process
template_class The class of nucleic acid that was used as primary starting material for the ...
template_quality Description and results of the quality control performed on the template mate...
time_label Informative label for the time point
time_max Upper/maximum value of the time interval
time_min Lower/minimum value of the time interval
time_point Time point designation for this repertoire within the group
time_quantity Time quantity
time_unit
time_value Value of the time point
timeMultiplier Estimated run time multiplier for statistics job
tissue The actual tissue sampled, e
tissue_processing Enzymatic digestion and/or physical methods used to isolate cells from sample
title Display name of repository
total_reads_passing_qc_filter Number of usable reads for analysis
tree Newick string describing the tree
umi_count Number of distinct UMIs represented by this sequence
unaligned_sequence entire V-sequence covered by this delineation
undocumented_alleles List of alleles inferred to be present and not documented in an identified Ge...
unrearranged_support Default unrearranged_support description
url Default slot description
used Default slot description
username Default slot description
uses Default slot description
utr_5_prime_end End co-ordinate in the sequence field of the 5 prime UTR (V-genes only)
utr_5_prime_start Start co-ordinate in the sequence field of the 5 prime UTR (V-genes only)
uuid object identifier
v_alignment_end End position of the V gene alignment in both the sequence_alignment and germl...
v_alignment_start Start position of the V gene alignment in both the sequence_alignment and ger...
v_call V gene with allele
v_cigar CIGAR string for the V gene alignment
v_frameshift True if the V gene in the query nucleotide sequence contains a translational ...
v_gene_delineations Default v_gene_delineations description
v_germline_alignment Aligned V gene germline sequence spanning the same region as the v_sequence_a...
v_germline_alignment_aa Amino acid translation of the v_germline_alignment field
v_germline_end Alignment end position in the V gene reference sequence (1-based closed inter...
v_germline_start Alignment start position in the V gene reference sequence (1-based closed int...
v_identity Fractional identity for the V gene alignment
v_rs_end End co-ordinate in the sequence field of the V recombination site (V-genes on...
v_rs_start Start co-ordinate in the sequence field of the V recombination site (V-genes ...
v_score Alignment score for the V gene
v_sequence_alignment Aligned portion of query sequence assigned to the V gene, including any indel...
v_sequence_alignment_aa Amino acid translation of the v_sequence_alignment field
v_sequence_end End position of the V gene in the query sequence (1-based closed interval)
v_sequence_start Start position of the V gene in the query sequence (1-based closed interval)
v_support V gene alignment E-value, p-value, likelihood, probability or other similar m...
validSeconds file path
value Level at which the property was observed in the experiment (non-normalized)
vdjserver Default slot description
VDJServer Default slot description
vdjserver_uuid link to object in Tapis Meta
version Timestamp of the object
virtual_pairing boolean to indicate if pairing was inferred
visualization Default slot description
vj_in_frame True if the V and J gene alignments are in-frame
wasAssociatedWith Default slot description
wasAttributedTo Default slot description
wasDerivedFrom Default slot description
wasGeneratedBy Default slot description
workflow_description The workflow description
workflow_mode The workflow analysis mode
workflow_name The workflow analysis name
write write permission

Enumerations

Enumeration Description
ADCAsyncQueryEndpointEnum
ADCAsyncQueryStatusEnum
AnalysisPropertiesStatusEnum
AncestryPopulationOntology
AntigenSourceSpeciesOntology
AntigenTypeEnum
CellSpeciesOntology
CellSubsetOntology
CellTypeEnum
CloneClassEnum
CollectionLocationOntology
CompleteSequencesEnum
CurationalTagsEnum
DegreeEnum
DerivationEnum
DiseaseDiagnosisOntology
FileTypeEnum
GeneOntology
InferenceProcessEnum
InferenceTypeEnum
JCodonFrameEnum
KeywordsStudyEnum
LibraryGenerationMethodEnum
LigandTypeEnum
LocationBirthOntology
LocusEnum
LocusSpeciesOntology
MhcClassEnum
MhcGene1Ontology
MhcGene2Ontology
NodeClassEnum
NodeTypeEnum
NotificationDetailsMethodEnum
ObservationTypeEnum
PairedReadDirectionEnum
PcrTargetLocusEnum
PhysicalLinkageEnum
PhysicalUnitOntology
ReadDirectionEnum
RearrangementTypeEnum
ReceptorTypeEnum
ReceptorVariableDomain1LocusEnum
ReceptorVariableDomain2LocusEnum
RepertoireTypeEnum
RoleEnum
SequenceTypeEnum
SexEnum
SpeciesOntology
SpeciesSubgroupTypeEnum
StatusEnum
StrandEnum
StudyTypeOntology
TemplateClassEnum
TimeUnitOntology
TissueOntology
VisualizationDocumentNameEnum

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description