Struct cgats::Cgats

pub struct Cgats {
    pub vendor: Option<Vendor>,
    pub meta: DataVec,
    pub fields: Vec<Field>,
    pub data_map: BTreeMap<usize, Sample>,
}

Fields

vendor: Option<Vendor>

meta: DataVec

fields: Vec<Field>

data_map: BTreeMap<usize, Sample>

Methods

impl Cgats

pub fn new() -> Cgats

Create a new empty CGATS object

pub fn sample_count(&self) -> usize

Returns the number of samples in the data

pub fn new_with_vendor(vendor: Vendor) -> Cgats

Create a new empty CGATS object with a Vendor

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Cgats>

Create a CGATS object from an existing CGATS file

pub fn write_to_file<P: AsRef<Path>>(&self, file: P) -> Result<()>

Write a CGATS object to a properly formatted CGATS file

pub fn format(&self) -> String

Format the entire CGATS object to a string

impl Cgats

pub fn average(collection: Vec<Cgats>) -> Result<Cgats>

Average all the values in a collection of CGATS. Returns an Error if the DATA_FORMATS or NUMBER_OF_SAMPLES don't match.

pub fn concatenate(collection: Vec<Cgats>) -> Result<Cgats>

Concatente multiple CGATS file from a collection. Returns an Error if the DATA_FORMATS don't match.

pub fn deltae(self, other: Cgats, method: DEMethod) -> Result<Cgats>

Calculate DELTA E of all samples between exactly 2 CGATS objects. Returns an Error if both CGATS do not contain LAB, or if the NUMBER_OF_SAMPLES differ.

pub fn de_method(&self) -> Result<(usize, DEMethod)>

Returns the index and the first DEMethod found in the DATA_FORMAT Returns an error if no DE is found

pub fn field_index(&self, field: &Field) -> Option<usize>

Returns the index of a given Field, returns None if not present.

pub fn reindex_sample_id(&mut self)

Replace SAMPLE_ID values with the index of the sample (starting from 0)

pub fn insert_sample_id(&mut self)

Insert SAMPLE_ID field into CGATS object

Trait Implementations

impl PartialEq<Cgats> for Cgats

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

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

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

This method tests for !=.

impl Default for Cgats

fn default() -> Cgats

Returns the "default value" for a type.

impl Clone for Cgats

fn clone(&self) -> Cgats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Cgats

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

Formats the value using the given formatter.

impl Debug for Cgats

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

Formats the value using the given formatter.