Skip to main content

CallPeaksOptions

Struct CallPeaksOptions 

Source
pub struct CallPeaksOptions {
Show 20 fields pub input: InputBam, pub shuffled: Option<String>, pub out: String, pub max_cov: Option<i32>, pub min_cov: Option<i32>, pub sd_cov: f64, pub max_fdr: f64, pub min_fire_frac: Option<f64>, pub min_fire_frac_filter: f64, pub min_frac_accessible: f64, pub window_size: usize, pub min_frac_overlap: f64, pub min_reciprocal_overlap: f64, pub high_reciprocal_overlap: f64, pub max_grouping_iterations: usize, pub fdr_table: Option<String>, pub fdr_table_out: Option<String>, pub include_nuc_msp: bool, pub haps: bool, pub min_fire_coverage: i32,
}

Fields§

§input: InputBam§shuffled: Option<String>

BED file with shuffled fiber positions (from bedtools shuffle) If not provided, will use all positions as real data (no FDR calculation)

§out: String

Output BED file with called peaks

§max_cov: Option<i32>

Maximum coverage threshold for filtering (optional)

§min_cov: Option<i32>

Minimum coverage threshold for filtering (optional)

§sd_cov: f64

Number of standard deviations from median coverage to use for filtering (default: 5) If set, will calculate median +/- (sd_cov * std_dev) and use those as min/max coverage This overrides –max-cov and –min-cov if those are not explicitly set

§max_fdr: f64

Maximum FDR threshold for peak calling (ignored if –min-fire-frac is set)

§min_fire_frac: Option<f64>

Minimum fraction of fibers with FIREs required to call a peak If set, skips FDR calculation and uses this threshold instead For example, 0.5 means at least 50% of fibers must have a FIRE at the peak position

§min_fire_frac_filter: f64

Minimum fraction of fibers with FIREs required as an additional filter (applied WITH FDR) Unlike –min-fire-frac, this is applied in addition to FDR filtering, not instead of it For example, 0.3 means at least 30% of fibers must have a FIRE AND FDR must be <= max_fdr

§min_frac_accessible: f64

Minimum fraction of accessible bases in peak

§window_size: usize

Rolling window size for finding local maxima (in base pairs)

§min_frac_overlap: f64

Minimum fraction of overlapping FIRE elements for merging peaks (Phase 2)

§min_reciprocal_overlap: f64

Minimum reciprocal overlap for merging peaks (Phase 3)

§high_reciprocal_overlap: f64

High reciprocal overlap threshold for initial merging (Phase 1)

§max_grouping_iterations: usize

Maximum number of grouping iterations for merging

§fdr_table: Option<String>

Skip the FDR table generation and use existing table

§fdr_table_out: Option<String>

Output the FDR table to this file

§include_nuc_msp: bool

Include nucleosome and MSP coverage in pileup (default: only FIRE coverage)

§haps: bool

Include haplotype-specific calls

§min_fire_coverage: i32

Minimum FIRE coverage required to calculate a score (default: 4)

Trait Implementations§

Source§

impl Args for CallPeaksOptions

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for CallPeaksOptions

Source§

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

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

impl FromArgMatches for CallPeaksOptions

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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