ReadThreadingAssembler

Struct ReadThreadingAssembler 

Source
pub struct ReadThreadingAssembler { /* private fields */ }

Implementations§

Source§

impl ReadThreadingAssembler

Source

pub fn new( max_allowed_paths_for_read_threading_assembler: i32, kmer_sizes: Vec<usize>, dont_increase_kmer_sizes_for_cycles: bool, allow_non_unique_kmers_in_ref: bool, num_pruning_samples: i32, prune_factor: usize, use_adaptive_pruning: bool, initial_error_rate_for_pruning: f64, pruning_log_odds_threshold: f64, pruning_seeding_log_odds_threshold: f64, max_unpruned_variants: usize, _use_linked_debruijn_graphs: bool, enable_legacy_graph_cycle_detection: bool, min_matching_bases_to_dangle_end_recovery: i32, disable_prune_factor_correction: bool, ) -> ReadThreadingAssembler

Source

pub fn default() -> Self

Source

pub fn default_with_kmers( max_allowed_paths_for_read_threading_assembler: i32, kmer_sizes: Vec<usize>, prune_factor: usize, ) -> Self

Source

pub fn set_just_return_raw_graph(&mut self, value: bool)

Source

pub fn set_remove_paths_not_connected_to_ref(&mut self, value: bool)

Source

pub fn set_recover_dangling_branches(&mut self, value: bool)

Source

pub fn run_local_assembly<'b>( &mut self, assembly_region: AssemblyRegion, ref_haplotype: &'b mut Haplotype<SimpleInterval>, full_reference_with_padding: Vec<u8>, ref_loc: SimpleInterval, sample_names: &'b [String], dangling_end_sw_parameters: Parameters, reference_to_haplotype_sw_parameters: Parameters, avx_mode: AVXMode, additional_kmer_sizes: Option<Vec<usize>>, ) -> AssemblyResultSet<ReadThreadingGraph>

Main entry point into the assembly engine. Build a set of deBruijn graphs out of the provided reference sequence and list of reads @param assemblyRegion AssemblyRegion object holding the reads which are to be used during assembly @param refHaplotype reference haplotype object @param fullReferenceWithPadding byte array holding the reference sequence with padding @param refLoc GenomeLoc object corresponding to the reference sequence with padding @param readErrorCorrector a ReadErrorCorrector object, if read are to be corrected before assembly. Can be null if no error corrector is to be used. @param aligner {@link SmithWatermanAligner} used to align dangling ends in assembly graphs to the reference sequence @return the resulting assembly-result-set

Source

pub fn assemble<'b>( &mut self, reads: &'b Vec<BirdToolRead>, ref_haplotype: &'b Haplotype<SimpleInterval>, sample_names: &'b [String], dangling_end_sw_parameters: &Parameters, avx_mode: AVXMode, additional_kmer_sizes: Option<Vec<usize>>, ) -> Vec<AssemblyResult<SimpleInterval, ReadThreadingGraph>>

Given reads and a reference haplotype give us graphs to use for constructing non-reference haplotypes.

@param reads the reads we’re going to assemble @param refHaplotype the reference haplotype @param aligner {@link SmithWatermanAligner} used to align dangling ends in assembly graphs to the reference sequence @return a non-null list of reads

Trait Implementations§

Source§

impl Clone for ReadThreadingAssembler

Source§

fn clone(&self) -> ReadThreadingAssembler

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReadThreadingAssembler

Source§

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

Formats the value using the given formatter. Read more

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.

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> Ungil for T
where T: Send,