Struct fqtk_lib::samples::SampleGroup

pub struct SampleGroup {
    pub samples: Vec<Sample>,
}

Struct for storing information about multiple samples and for defining functions associated with groups of Samples, rather than individual structs.

Fields

samples: Vec<Sample>

A group of samples

Implementations

impl SampleGroup

pub fn from_samples(samples: &[Sample]) -> Self

Validates a group of Samples and instantiates a Self struct if they are valid. Will clone the Sample structs and change the number on the ordinal field on those cloneto match the order in which they are stored in this Self

Panics

• Will panic if sample metadata sheet is improperly formatted
• Will panic if there are duplicate sample names provided
• Will panic if there are duplicate barcodes provided
• Will panic if barcodes don’t all have the same length

pub fn from_file<P: AsRef<Path>>(path: &P) -> Result<SampleGroup, FgError>

Attempts to load a Self object from a file. File should be delimeted with delimiter, should have a header with name and barcode fields present.

Errors

• Will error if file cannot be read, either due to not the file not existing or due to the format being different from the format expected.

Panics

• Will panic if sample metadata sheet is improperly formatted
• Will panic if a different number of names and barcodes are provided
• Will panic if each

Trait Implementations

impl Clone for SampleGroup

fn clone(&self) -> SampleGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleGroup

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

Formats the value using the given formatter.

impl Display for SampleGroup

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

Formats the value using the given formatter.

impl PartialEq<SampleGroup> for SampleGroup

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SampleGroup

impl StructuralEq for SampleGroup

impl StructuralPartialEq for SampleGroup