Struct genomics::Sample

pub struct Sample { /* fields omitted */ }

Implementations

impl Sample

pub fn new() -> Self

Constructs a new empty Sample

The Sample can be filled up iteratively by calling observation().

pub fn flush(&mut self) -> Result<(), Box<dyn Error>>

Recreates the Sample's matrix.

This function is called before a matrix calculation so there is no need to explicitly call it after observing data.

pub fn allele(&mut self, locus: &str, variation: &str) -> Allele

Returns the allele in this locus

This will create the locus and allele if needed and mark the Sample as dirty. Dirty samples will updated before the next call that requires a matrix calculation or when flush() is called.

pub fn group(&mut self, group: &str) -> Arc<Group>

Returns a reference to a Group

This will create the Group if needed and mark the Sample as dirty.

pub fn _observe(&mut self, observation: Observation)

Observes a single Observation

This function is normally called by a Sample's observe function to read in data. To read in data from an arbitrary data source. Implement an Iterator with type Item = Observation.

pub fn observe<I>(&mut self, observable: I) -> Result<(), Box<dyn Error>> where
    I: Iterator<Item = Result<Observation, Box<dyn Error>>>, 

Observe all the data in the argument.

pub fn loci_names(&self) -> Vec<&String>

A list of the names of all loci in a sample

Trait Implementations

impl<'_> From<&'_ Sample> for Vec<AlleleCount>

fn from(sample: &Sample) -> Vec<AlleleCount>

Performs the conversion.