Struct MaxSeqErrors 

pub struct MaxSeqErrors { /* private fields */ }

Struct of how many sequencing errrors are allowed

Implementations

impl MaxSeqErrors

pub fn new( sample_errors_option: Option<u16>, sample_barcode_size_option: Option<u16>, barcode_errors_option: Option<u16>, barcode_sizes: Vec<u16>, constant_errors_option: Option<u16>, constant_region_size: u16, min_quality: f32, ) -> Self

Create a new sequence error struct

Example

use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);

pub fn max_constant_errors(&self) -> u16

Returns the maximum allowed constant region errors

Example

use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_constant_errors(), 6);
let barcode_sizes = vec![8,8,8];
let constant_errors_option = Some(3);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_constant_errors(), 3);

pub fn max_sample_errors(&self) -> u16

Returns the maximum allowed sample barcode errors

Example

use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_sample_errors(), 2);
let barcode_sizes = vec![8,8,8];
let sample_errors_option = Some(3);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_sample_errors(), 3);

pub fn max_barcode_errors(&self) -> &[u16]

Returns the maximum allowed errors within each counted barcode

Example

use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_barcode_errors(), vec![1,1,1]);
let barcode_sizes = vec![8,8,8];
let barcode_errors_option = Some(2);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_barcode_errors(), vec![2,2,2]);

Trait Implementations

impl Clone for MaxSeqErrors

fn clone(&self) -> MaxSeqErrors

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaxSeqErrors

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

Formats the value using the given formatter.

impl Display for MaxSeqErrors

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

Formats the value using the given formatter.

impl PartialEq for MaxSeqErrors

fn eq(&self, other: &MaxSeqErrors) -> 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 StructuralPartialEq for MaxSeqErrors