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
impl AnalysisParams
Sourcepub fn to_args(&self) -> Vec<String>
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).
Sourcepub fn validate(&self) -> Result<()>
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.
Sourcepub fn support_threshold(&self) -> Param<u64>
pub fn support_threshold(&self) -> Param<u64>
The support threshold with its origin.
Sourcepub fn validation(&self) -> Param<ValidationMode>
pub fn validation(&self) -> Param<ValidationMode>
The validation mode with its origin.
Sourcepub fn kmer_length(&self, alphabet: Alphabet) -> Param<usize>
pub fn kmer_length(&self, alphabet: Alphabet) -> Param<usize>
The k-mer length with its origin, given the resolved alphabet.
Sourcepub fn header_fill(&self) -> Param<String>
pub fn header_fill(&self) -> Param<String>
The header fill value with its origin.
Trait Implementations§
Source§impl Clone for AnalysisParams
impl Clone for AnalysisParams
Source§fn clone(&self) -> AnalysisParams
fn clone(&self) -> AnalysisParams
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AnalysisParams
impl Debug for AnalysisParams
Source§impl Default for AnalysisParams
impl Default for AnalysisParams
Source§fn default() -> AnalysisParams
fn default() -> AnalysisParams
Source§impl PartialEq for AnalysisParams
impl PartialEq for AnalysisParams
impl StructuralPartialEq for AnalysisParams
Auto Trait Implementations§
impl Freeze for AnalysisParams
impl RefUnwindSafe for AnalysisParams
impl Send for AnalysisParams
impl Sync for AnalysisParams
impl Unpin for AnalysisParams
impl UnsafeUnpin for AnalysisParams
impl UnwindSafe for AnalysisParams
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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