Skip to content

portable-microhaplotype-object

A schema to define the minimum amount of data needed to export a microhaplotype calling pipeline analysis with associated metadata

URI: https://plasmogenepi.github.io/portable-microhaplotype-object

Name: portable-microhaplotype-object

Classes

Class Description
BioinformaticsMethodInfo the targeted amplicon bioinformatics methods used to generate the microhaplot...
BioinformaticsRunInfo Information about the pipeline run that generated microhaplotype_detected and...
BioMethod bioinformatics methodology description with info on program, version, and arg...
DetectedMicrohaplotypes the microhaplotypes detected in a targeted amplicon analysis
DetectedMicrohaplotypesForSample Microhaplotypes detected for a sample for all targets
DetectedMicrohaplotypesForTarget Microhaplotypes detected for a specific target
GenomeInfo information on a genome
GenomicLocation information on the genomic location of specific sequence
LibrarySampleInfo Information about a specific amplification and sequencing of a specimen
MarkerOfInterest A specific genomic location of interest, e
MaskingInfo information about a subsegment of the sequence that should be masked
MicrohaplotypeForTarget Microhaplotype detected for a specific target
PanelInfo information on a panel of targeted amplicon primer pairs
ParasiteDensity method and value of determined parasite density
PlateInfo Information about a plate location, e
PmoGenerationMethod Information about how a PMO was generated
PmoHeader Information on the PMO file itself
PortableMicrohaplotypeObject Information on final microhaplotype results from a targeted amplicon analysis...
PrimerInfo information on a primer sequence
ProjectInfo Information on a project underwhich a collection of specimens belong to
ProteinVariant information on a variant in protein sequence
Pseudocigar information on pseudocigar for a sequence
ReactionInfo information on a panel of targeted amplicon primer pairs
ReadCountsByStage Information on the reads counts at several stages of a pipeline
ReadCountsByStageForLibrarySample Information on the reads counts at several stages of a pipeline for a library...
ReadCountsByStageForTarget Information on the reads counts at several stages of a pipeline for a target
RepresentativeMicrohaplotype the representative sequence for a microhaplotype
RepresentativeMicrohaplotypes a collection of representative sequences for microhaplotypes for all targets
RepresentativeMicrohaplotypesForTarget a list of the representative sequence for the microhaplotypes for a target
SequencingInfo Information on sequencing info
SpecimenInfo Information on specimen info
StageReadCounts Information on the reads counts at several stages
TargetInfo Information about a specific targeted microhaplotype
TravelInfo Information on travel info

Slots

Slot Description
additional_argument any additional arguments that differ from the default arguments
alt_annotations a list of additional annotations associated with this microhaplotype, e
alt_seq a possible alternative sequence of this genomic location
alternate_identifiers a list of alternative names
alternative_gene_name an alternative gene name
associated_protein_variants a list of protein variants for this haplotype, e
associated_seq_variants a list of sequence variants for this haplotype, e
associations a list of associations with this marker, e
bed_net_usage approximate usage of bed net while traveling, 1 = 100% nights with bed net, 0...
bioinformatics_methods_id the index into the bioinformatics_methods_info list
bioinformatics_methods_info the bioinformatics pipeline/methods used to generated the microhaplotype anal...
bioinformatics_run_id the index into bioinformatics_run_info list
bioinformatics_run_info the runtime info for the bioinformatics pipeline used to generated the microh...
bioinformatics_run_name a name to for this run, needs to be unique to each run
BioProject_accession an SRA bioproject accession e
blood_meal whether host specimen has had a recent blood meal
chrom the chromosome name
chromosomes a list of the chromosomes/contigs found within this genome
codon_genomic_location the position within the genomic sequence of the codon
collection_country the name of country collected in, would be the same as admin level 0
collection_date the date of the specimen collection, can be YYYY, YYYY-MM, or YYYY-MM-DD
creation_date the date of when the PMO file was created or modified, should be YYYY-MM-DD
date_measured the date the qpcr was performed, can be YYYY, YYYY-MM, or YYYY-MM-DD
density_method_comments additional comments about how the density was performed
detected_microhaplotypes the microhaplotypes detected in this projects
drug_usage Any drug used by subject and the frequency of usage; can include multiple dru...
end the end of the location, 0-based positioning
env_broad_scale the broad environment from which the specimen was collected, e
env_local_scale the local environment from which the specimen was collected, e
env_medium the environment medium from which the specimen was collected from
experiment_accession ERA/SRA experiment accession number for the sample if it was submitted
fastqs_loc the location (url or filename path) of the fastqs for a library run
forward_primer the forward primer for this target
gene_name an identifier of the gene, if any, is being covered with this targeted
generation_method the generation method to create this PMO
genome_id the index to the genome in the targeted_genomes list that this location refer...
genome_version the genome version
geo_admin1 geographical admin level 1, the secondary large demarcation of a nation (nati...
geo_admin2 geographical admin level 2, the third large demarcation of a nation (nation =...
geo_admin3 geographical admin level 3, the third large demarcation of a nation (nation =...
gff_url a link to the where this genome's annotation file could be downloaded
gravid whether host specimen is currently pregnant
gravidity the gravidity of the specimen host (number of previous pregnancies)
has_travel_out_six_month has travelled out from local region in the last six months
host_age if specimen is from a person, the age in years of the person, can be float va...
host_sex if specimen is collected from a host with a sex, the sex listed for that host
host_subject_id an identifier for the individual a specimen was collected from
host_taxon_id the NCBI taxonomy number of the host that the specimen was collected from
insert_location the intended genomic location of the insert of the amplicon (the location bet...
lat_lon the latitude and longitude of a specific site
library_kit Name, version, and applicable cell or cycle numbers for the kit used to prepa...
library_layout Specify the configuration of reads, e
library_prep_plate_info plate location of where library was prepared for sequencing
library_sample_id the index into the library_sample_info list
library_sample_info a list of libraries of all the seq/amp of the specimens within this PMO file
library_sample_name a unique identifier for this sequencing/amplification run
library_samples a list of the microhaplotypes detected for all samples with a list for each t...
library_screen Describe enrichment, screening, or normalization methods applied during ampli...
library_selection how amplification was done (common are PCR=Source material was selected by de...
library_source Source of amplification material e
library_strategy what the nuceloacid sequencing/amplification strategy was (common names are A...
location what the intended genomic location of the primer is
marker_location the genomic location
markers_of_interest a list of markers of interest that are covered by this target
masking masking info for the sequence
masking_generation_description a description of how the masking information was generated
methods methodology used to generate the microhaplotype data stored in this PMO, e
mhap_id the index for a microhaplotype for a target in the representative_microhaplot...
mhap_location a genomic location that was analyzed for this target info, this allows listin...
mhaps a list of the microhaplotypes detected for this target
mhaps_target_id the index for a target in the representative_microhaplotypes list
microhaplotype_name an optional name for this microhaplotype
microhaplotypes a list of all the microhaplotypes for a target
name name of the genome
nucl_acid_amp Link to a reference or kit that describes the enzymatic amplification of nucl...
nucl_acid_amp_date the date of the nucleoacid amplification
nucl_acid_ext Link to a reference or kit that describes the recovery of nucleic acids from ...
nucl_acid_ext_date the date of the nucleoacid extraction
panel_id the index into the panel_info list
panel_info a list of info on the panels
panel_name a name for the panel
panel_targets a list of the target indexes in the target_info list
parasite_density the density in microliters
parasite_density_info one or more parasite densities in microliters for this specimen
parasite_density_method the method of how this density was obtained
pcr_cond the method/conditions for PCR, List PCR cycles used to amplify the target
plate_col the column position
plate_name a name for the plate
plate_row the row position
pmo_header the PMO information for this file including version etc
pmo_version the version of the PMO file, should be in the format of v[MAJOR]
program name of the program used for this portion of the pipeline
program_description a short description of what this method does
program_name the name of the program
program_url a url pointing to code base of a program, e
program_version the version of program, should be in the format of v[MAJOR]
project_collector_chief_scientist can be collection of names separated by a semicolon if multiple people involv...
project_contributors a list of collaborators who contributed to this project
project_description a short description of the project
project_id the index into the project_info list
project_info the information about the projects stored in this PMO
project_name a name for the project, should be unique if multiple projects listed
project_type the type of project conducted, e
protein_location the position within the protein, the chromosome in this case would be the tra...
pseudocigar the pseudocigar of the haplotype
pseudocigar_generation_description a description of how the pseudocigar information was generated
pseudocigar_seq the pseudocigar itself
qpcr_parasite_density_info qpcr parasite density measurement for this extracted sample
quality the ASCII fastq per base quality score for this sequence, this is optional, m...
reaction_name a name for this reaction
reactions a list of 1 or more reactions that this panel contains, each reactions list t...
read_counts_by_library_sample_by_stage a list by library_sample for the counts at each stage
read_counts_by_stage the read counts for library_samples for different stages of the pipeline
read_counts_for_targets a list of counts by stage for a target
reads the read count
ref_loc the genomic location the pseudocigar is in reference to
ref_seq the reference sequence of this genomic location
replacement_size the size of replacement mask
representative_microhaplotypes a list of the information on the representative microhaplotypes
reverse_primer the reverse primer for this target
run_accession ERA/SRA run accession number for the sample if it was submitted
run_date the date when the run was done, should be YYYY-MM-DD
seq the sequence
seq_center Name of facility where sequencing was performed (lab, core facility, or compa...
seq_date the date of sequencing, should be YYYY-MM or YYYY-MM-DD
seq_instrument_model the sequencing instrument model used to sequence the run, e
seq_platform the sequencing technology used to sequence the run, e
seq_segment_size the size of the masking
seq_start the start of the masking
sequencing_info a list of sequencing infos for this PMO file
sequencing_info_id the index into the sequencing_info list
sequencing_info_name a name for a specific sequencing run, e
specimen_accession if specimen is deposited in a database, what accession is it associated with
specimen_collect_device the way the specimen was collected, e
specimen_comments any additional comments about the specimen
specimen_id the index into the specimen_info list
specimen_info a list of all the specimens within this PMO file
specimen_name an identifier for the specimen, should be unique within this sample set
specimen_store_loc the specimen store site, address or facility name
specimen_taxon_id the NCBI taxonomy number of the organism(s) in the specimen, can list multipl...
specimen_type what type of specimen this is, e
stage the stage of the pipeline, e
stages the read counts by each stage
start the start of the location, 0-based positioning
storage_plate_info plate location of where specimen is stored if stored in a plate
strand which strand the location is, either + for plus strand or - for negative stra...
target_attributes a list of classification types for this target
target_id the index into the target_info list
target_info a list of info on the targets
target_name a name for this target
target_results a list of the microhaplotypes detected for a list of targets
targeted_genomes a list of genomes that any genomic location information refers to
targets a list of the microhaplotypes for each targets
taxon_id the NCBI taxonomy number, can be a list of values if it's a genome file that ...
total_raw_count the raw counts off the sequencing machine that a sample began with
travel_country the name of country, would be the same as admin level 0
travel_end_date the date of the end of travel, can be approximate, should be YYYY-MM or YYYY-...
travel_out_six_month Specification of the countries travelled in the last six months; can include ...
travel_start_date the date of the start of travel, can be approximate, should be YYYY-MM or YYY...
treatment_status If person has been treated with drugs, what was the treatment outcome
umis the unique molecular identifier (umi) count for this microhaplotype
url a link to the where this genome file could be downloaded

Enumerations

Enumeration Description

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