Enum noodles::vcf::record::genotype::field::Key

pub enum Key {
    ReadDepths,
    ForwardStrandReadDepths,
    ReverseStrandReadDepths,
    ReadDepth,
    ExpectedAlternateAlleleCounts,
    Filter,
    GenotypeLikelihoods,
    GenotypePosteriorProbabilities,
    ConditionalGenotypeQuality,
    Genotype,
    HaplotypeQuality,
    MappingQuality,
    RoundedGenotypeLikelihoods,
    RoundedGenotypePosteriorProbabilities,
    PhasingQuality,
    PhaseSet,
    GenotypeCopyNumber,
    GenotypeCopyNumberQuality,
    GenotypeCopyNumberLikelihoods,
    GenotypeCopyNumberPosteriorProbabilities,
    NovelVariantQualityScore,
    HaplotypeId,
    AncestralHaplotypeId,
    Other(String, Number, Type, String),
}

A VCF record genotype field key.

Variants

ReadDepths

Read depth for each allele (AD).

ForwardStrandReadDepths

Read depth for each allele on the forward strand (ADF).

ReverseStrandReadDepths

Read depth for each allele on the reverse strand (ADR).

ReadDepth

Read depth (DP).

ExpectedAlternateAlleleCounts

Expected alternate allele counts (EC).

Filter

Filter indicating if this genotype was “called” (FT).

GenotypeLikelihoods

Genotype likelihoods (GL).

GenotypePosteriorProbabilities

Genotype posterior probabilities (GP).

ConditionalGenotypeQuality

Conditional genotype quality (GQ).

Genotype

Genotype (GT).

HaplotypeQuality

Haplotype quality (HQ).

MappingQuality

RMS mapping quality (MQ).

RoundedGenotypeLikelihoods

Phred-scaled genotype likelihoods rounded to the closest integer (PL).

RoundedGenotypePosteriorProbabilities

Phred-scaled genotype posterior probabilities rounded to the closest integer (PP).

PhasingQuality

Phasing quality (PQ).

PhaseSet

Phase set (PS).

GenotypeCopyNumber

Copy number genotype for imprecise events (CN).

GenotypeCopyNumberQuality

Copy number genotype quality for imprecise events (CNQ).

GenotypeCopyNumberLikelihoods

Copy number genotype likelihood for imprecise events (CNL).

GenotypeCopyNumberPosteriorProbabilities

Copy number posterior probabilities (CNP).

NovelVariantQualityScore

Phred style probability score that the variant is novel (NQ).

HaplotypeId

Unique haplotype identifier (HAP).

AncestralHaplotypeId

Unique identifier of ancestral haplotype (AHAP).

Other(String, Number, Type, String)

Any other non-reserved key.

Tuple Fields of Other

0: String1: Number2: Type3: String

Implementations

impl Key

pub fn number(&self) -> Number

Returns the cardinality of the genotype field value.

Examples

use noodles_vcf::{header::Number, record::genotype::field::Key};
assert_eq!(Key::Genotype.number(), Number::Count(1));

pub fn ty(&self) -> Type

Returns the type of the genotype field value.

Examples

use noodles_vcf::{header::format::Type, record::genotype::field::Key};
assert_eq!(Key::Genotype.ty(), Type::String);

pub fn description(&self) -> &str

Returns the description of the genotype field.

Examples

use noodles_vcf::record::genotype::field::Key;
assert_eq!(Key::Genotype.description(), "Genotype");

Trait Implementations

impl AsRef<str> for Key

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Key

pub fn clone(&self) -> Key

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Key

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Key

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Key> for Format

pub fn from(key: Key) -> Format

Performs the conversion.

impl FromStr for Key

type Err = ParseError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Key, <Key as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Key

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Key> for Key

pub fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Key) -> bool

This method tests for !=.

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key