Skip to main content

AnalysisParams

Struct AnalysisParams 

Source
pub struct AnalysisParams {
    pub alphabet: Option<Alphabet>,
    pub kmer_length: Option<usize>,
    pub support_threshold: Option<u64>,
    pub estimator: Option<Estimator>,
    pub validation: Option<ValidationMode>,
    pub min_coverage: Option<f64>,
    pub query_name: Option<String>,
    pub header_format: Option<Vec<String>>,
    pub metadata_fields: Option<Vec<String>>,
    pub header_fill: Option<String>,
}
Expand description

Parameters of one analysis. None means “use the default” (or derive from the data).

Fields§

§alphabet: Option<Alphabet>

Sequence alphabet; None detects it from the data.

§kmer_length: Option<usize>

k-mer length; None uses the alphabet’s default.

§support_threshold: Option<u64>

Support threshold T.

§estimator: Option<Estimator>

Entropy estimator.

§validation: Option<ValidationMode>

Handling of characters outside the alphabet.

§min_coverage: Option<f64>

Flag positions whose sample coverage is below this value (0–1).

§query_name: Option<String>

Name of the analysed protein or gene; None derives it from the input file name.

§header_format: Option<Vec<String>>

Names of the |-separated header fields.

§metadata_fields: Option<Vec<String>>

Header fields to stratify variants by (default: all of header_format).

§header_fill: Option<String>

Value used for empty header fields and mismatched headers.

Implementations§

Source§

impl AnalysisParams

Source

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

The dima analyze options that reproduce these parameters: long option names, unset parameters omitted, header field lists joined with |. Front ends use it to record and show the equivalent command (D103).

Source

pub fn validate(&self) -> Result<()>

Checks the parameters that can be checked without data. Header names are checked by the header module, k ≤ alignment length once the alignment length is known.

§Errors

A usage error naming the parameter and the accepted range.

Source

pub fn support_threshold(&self) -> Param<u64>

The support threshold with its origin.

Source

pub fn estimator(&self) -> Param<Estimator>

The estimator with its origin.

Source

pub fn validation(&self) -> Param<ValidationMode>

The validation mode with its origin.

Source

pub fn kmer_length(&self, alphabet: Alphabet) -> Param<usize>

The k-mer length with its origin, given the resolved alphabet.

Source

pub fn header_fill(&self) -> Param<String>

The header fill value with its origin.

Trait Implementations§

Source§

impl Clone for AnalysisParams

Source§

fn clone(&self) -> AnalysisParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnalysisParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnalysisParams

Source§

fn default() -> AnalysisParams

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AnalysisParams

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AnalysisParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more