scran::PairwiseEffects::Results< Stat_ > Struct Template Reference

Pairwise effect size results. More...

#include <PairwiseEffects.hpp>

Public Attributes
std::vector< Stat_ >	cohen
std::vector< Stat_ >	auc
std::vector< Stat_ >	lfc
std::vector< Stat_ >	delta_detected
std::vector< std::vector< Stat_ > >	means
std::vector< std::vector< Stat_ > >	detected

Detailed Description

template<typename Stat_>
struct scran::PairwiseEffects::Results< Stat_ >

Pairwise effect size results.

Template Parameters

Stat_

Floating-point type to store the statistics.

For any given effect size, the pairwise statistics are stored in a 3-dimensional array. The first dimension is the fastest changing, is of length equal to the number of groups, and represents the first group. The second dimension is the next fastest changing, is also of length equal to the number of groups, and represents the second group. The third dimension is the slowest changing, is of length equal to the number of genes, and represents the gene. Thus, an entry $(i, j, k)$ represents the effect size of gene $k$ for group $i$ against group $j$.

Member Data Documentation

cohen

template<typename Stat_ >

std::vector<Stat_> scran::PairwiseEffects::Results< Stat_ >::cohen

Vector of pairwise Cohen's d, to be interpreted as a 3-dimensional array - see the description in Results for more details. Only returned if set_compute_cohen() is true.

auc

template<typename Stat_ >

std::vector<Stat_> scran::PairwiseEffects::Results< Stat_ >::auc

Vector of pairwise AUCs, to be interpreted as a 3-dimensional array - see the description in Results for more details. Only returned if set_compute_auc() is true.

lfc

template<typename Stat_ >

std::vector<Stat_> scran::PairwiseEffects::Results< Stat_ >::lfc

Vector of pairwise log-fold changes, to be interpreted as a 3-dimensional array - see the description in Results for more details. Only returned if set_compute_lfc() is true.

delta_detected

template<typename Stat_ >

std::vector<Stat_> scran::PairwiseEffects::Results< Stat_ >::delta_detected

Vector of pairwise delta-detected, to be interpreted as a 3-dimensional array - see the description in Results for more details. Only returned if set_compute_delta_detected() is true.

means

template<typename Stat_ >

std::vector<std::vector<Stat_> > scran::PairwiseEffects::Results< Stat_ >::means

Each element of means corresponds to a group and is itself a vector of length equal to the number of genes. Each element of means[i] corresponds to a gene and contains the mean expression of that gene in group i. When used in run_blocked(), the grand average across all blocks is reported.

detected

template<typename Stat_ >

std::vector<std::vector<Stat_> > scran::PairwiseEffects::Results< Stat_ >::detected

Each element of detected corresponds to a group and is itself a vector of length equal to the number of genes. Each element of detected[i] corresponds to a gene and contains the proportion of detected expression of that gene in group i. When used in run_blocked(), the grand average across all blocks is reported.

---

The documentation for this struct was generated from the following file:

• scran/differential_analysis/PairwiseEffects.hpp