Struct IDTag 

pub struct IDTag { /* private fields */ }

type for IDs and tags together

Implementations

impl IDTag

pub fn new(id: ID, tag: Tag) -> IDTag

pub fn tag(&self) -> Tag

Trait Implementations

impl Clone for IDTag

fn clone(&self) -> IDTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IDTag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IDTag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for IDTag

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IDTag

fn cmp(&self, other: &IDTag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IDTag

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for IDTag

fn partial_cmp(&self, other: &IDTag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReadData for IDTag

fn new(id: ID, tag: Tag) -> Self

generate a read data from an ID and a tag

fn read_data( gene_ids: &mut BiMap<String, ID>, read_name: &[u8], tag: Tag, ) -> Self

geneate a read data, IDs and IDTags can only be generated from Marbel reads

fn get_tag(&self) -> Option<Tag>

if available, get a tag

fn read_datas() -> ReadDatas

retrun a ReadDatas enum to check which kind of ReadData is present

impl Serialize for IDTag

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SummaryData<IDTag> for IDData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn p_value(&self, _config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, _config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn fix_edge_data(&mut self, _exts: Exts)

fix the EdgeMult by removing hanging edges

fn set_edge_mults(&mut self, _edge_mults: Option<EdgeMult>)

set the edge mults

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, _mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

impl SummaryData<IDTag> for IDEMData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn set_edge_mults(&mut self, edge_mults: Option<EdgeMult>)

set the edge mults

fn fix_edge_data(&mut self, exts: Exts)

fix the EdgeMult by removing hanging edges

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn p_value(&self, _config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, _config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, _mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

impl SummaryData<IDTag> for IDMapEMData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn set_edge_mults(&mut self, edge_mults: Option<EdgeMult>)

set the edge mults

fn fix_edge_data(&mut self, exts: Exts)

fix the EdgeMult by removing hanging edges

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn p_value(&self, _config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, _config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

impl SummaryData<IDTag> for IDMapEMQualityData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn set_edge_mults(&mut self, edge_mults: Option<EdgeMult>)

set the edge mults

fn fix_edge_data(&mut self, exts: Exts)

fix the EdgeMult by removing hanging edges

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn p_value(&self, _config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, _config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

impl SummaryData<IDTag> for IDSumData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn p_value(&self, _config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, _config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn fix_edge_data(&mut self, _exts: Exts)

fix the EdgeMult by removing hanging edges

fn set_edge_mults(&mut self, _edge_mults: Option<EdgeMult>)

set the edge mults

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, _mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

impl SummaryData<IDTag> for IDTagsCountsData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn p_value(&self, config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn fix_edge_data(&mut self, _exts: Exts)

fix the EdgeMult by removing hanging edges

fn set_edge_mults(&mut self, _edge_mults: Option<EdgeMult>)

set the edge mults

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, _mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

impl SummaryData<IDTag> for IDTagsCountsPEMData

fn print( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data

fn print_ol( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in for json

fn print_json( &self, translator: &Translator, config: &SummaryConfig, id_group_translator: Option<&HashMap<ID, ID>>, ) -> String

format the node data in one line

fn tags(&self) -> Option<Tags>

get Tags and the overall count, returns None if data is insufficient

fn sum(&self) -> Option<u32>

get the number of observations, returns None if data is insufficient

fn sample_count(&self) -> Option<usize>

get the number of samples the sequence was observed in, returns None if data is insufficient

fn mem(&self) -> usize

get the size of the structure, including contents of boxed slices

fn p_value(&self, config: &SummaryConfig) -> Option<f32>

get the p-value, returns None if data is insufficient

fn fold_change(&self, config: &SummaryConfig) -> Option<f32>

get the log2(fold change), returns None if data is insufficient

fn valid(&self, config: &SummaryConfig) -> bool

check if node is valid according to: min kmer obs, group fraction, p-value

fn edge_mults(&self) -> Option<&EdgeMult>

get the coverage of the node edges

fn set_edge_mults(&mut self, edge_mults: Option<EdgeMult>)

set the edge mults

fn fix_edge_data(&mut self, exts: Exts)

fix the EdgeMult by removing hanging edges

fn ids(&self) -> Option<&[ID]>

get the IDs, returns None if data is insufficient

fn join_test(&self, other: &Self) -> bool

check if the data can be joined into one

fn summarize<K: Kmer, F: Iterator<Item = KmerDataItem<K, IDTag>>>( items: F, config: &SummaryConfig, ) -> (bool, Exts, Self)

summarize k-mers

fn summarizer() -> Summarizers

check summerizer kind

fn quality(&self) -> Option<BaseQuality>

get the quality of the node k-mer

fn mapped_ids(&self) -> Option<&[ID]>

get a reference to the mapped ids, returns None if data is insufficient

fn set_mapped_ids(&mut self, _mapped_ids: Box<[ID]>)

add mapped ids to the node data

fn mapped_edge_ids(&self) -> Option<&EdgeMap>

get a reference to the IDs mapped to the node edges, returns None id data is insuffivient

fn set_mapped_edge_ids(&mut self, _mapped_edge_ids: Option<EdgeMap>)

add mapped IDs to the node’s edges

impl Copy for IDTag

impl Eq for IDTag

impl StructuralPartialEq for IDTag