Skip to main content

MArrayLm

Struct MArrayLm 

Source
pub struct MArrayLm {
Show 24 fields pub n_genes: usize, pub n_samples: usize, pub n_coef: usize, pub coefficients: Vec<f64>, pub stdev_unscaled: Vec<f64>, pub sigma: Vec<f64>, pub df_residual: Vec<f64>, pub cov_coefficients: Vec<f64>, pub pivot: Vec<usize>, pub rank: usize, pub design: Vec<f64>, pub amean: Option<Vec<f64>>, pub contrasts: Option<Vec<f64>>, pub df_prior: Option<Vec<f64>>, pub s2_prior: Option<Vec<f64>>, pub var_prior: Option<Vec<f64>>, pub proportion: Option<f64>, pub s2_post: Option<Vec<f64>>, pub t: Option<Vec<f64>>, pub df_total: Option<Vec<f64>>, pub p_value: Option<Vec<f64>>, pub lods: Option<Vec<f64>>, pub f_stat: Option<Vec<f64>>, pub f_p_value: Option<Vec<f64>>,
}
Expand description

A linear model fit, growing as the pipeline runs over it.

Everything before MArrayLm::contrasts comes from lm_fit. After contrasts_fit the coefficient axis is the contrast axis, and MArrayLm::n_coef counts contrasts rather than design columns.

Fields§

§n_genes: usize

Number of genes.

§n_samples: usize

Number of samples in the design.

§n_coef: usize

Width of the coefficient axis: design columns, or contrasts once contrasts_fit has run.

§coefficients: Vec<f64>

Coefficients, row-major n_genes * n_coef. NaN where not estimable.

§stdev_unscaled: Vec<f64>

Unscaled standard deviations, row-major n_genes * n_coef.

§sigma: Vec<f64>

Residual standard deviation per gene.

§df_residual: Vec<f64>

Residual degrees of freedom per gene.

§cov_coefficients: Vec<f64>

Unscaled covariance of the estimable coefficients, row-major rank * rank, or n_coef * n_coef after contrasts_fit.

§pivot: Vec<usize>

Design column indices, accepted ones first. Length is the original n_coef, which after contrasts_fit is no longer this struct’s.

§rank: usize

Rank of the design.

§design: Vec<f64>

Design matrix, row-major n_samples * pivot.len().

§amean: Option<Vec<f64>>

Row means of the response, one per gene. limma’s Amean.

None when the caller had none to give, which makes EBayesTrend::Amean an error rather than a silent no-trend fit.

§contrasts: Option<Vec<f64>>

Contrast matrix, column-major original n_coef * n_coef, once contrasts_fit has run.

§df_prior: Option<Vec<f64>>

Prior degrees of freedom. Length one, or n_genes for a robust fit.

§s2_prior: Option<Vec<f64>>

Prior variance. Length one, or n_genes for a trended fit.

§var_prior: Option<Vec<f64>>

Prior variance of the coefficients, one per coefficient. The B-statistic’s v0.

§proportion: Option<f64>

Assumed proportion of differentially expressed genes.

§s2_post: Option<Vec<f64>>

Posterior variance per gene.

§t: Option<Vec<f64>>

Moderated t, row-major n_genes * n_coef.

§df_total: Option<Vec<f64>>

Total degrees of freedom per gene, residual plus prior, capped.

§p_value: Option<Vec<f64>>

Two-sided p-values, row-major n_genes * n_coef.

§lods: Option<Vec<f64>>

Log-odds of differential expression, row-major n_genes * n_coef.

§f_stat: Option<Vec<f64>>

Moderated F per gene. None when the design is not full rank.

§f_p_value: Option<Vec<f64>>

P-value of MArrayLm::f_stat.

Implementations§

Source§

impl MArrayLm

Source

pub fn from_lm_fit( fit: LmFitResult, design: &[f64], n_coef: usize, n_samples: usize, amean: Option<Vec<f64>>, ) -> Result<Self, EdgeErrors>

Wraps an lm_fit result, with the response’s row means alongside.

§Params
  • fit - What lm_fit returned
  • design - Row-major design, n_samples * n_coef
  • n_coef - Number of design columns
  • n_samples - Number of samples
  • amean - Row means of the response, one per gene, or None. voom returns them as crate::limma::voom::VoomResult::amean.
§Returns

The fit object with every empirical Bayes field unset, or EdgeErrors::LengthMismatch if design or amean disagrees with the fit’s shape.

Trait Implementations§

Source§

impl Clone for MArrayLm

Source§

fn clone(&self) -> Self

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 MArrayLm

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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