Options for summarize_effects(). More...

#include <summarize_effects.hpp>

Public Attributes
int	num_threads = 1

bool	compute_min = true

bool	compute_mean = true

bool	compute_median = true

bool	compute_max = true

bool	compute_min_rank = true

std::optional< std::vector< double > >	compute_quantiles

bool	min_rank_preserve_ties = false

Detailed Description

Options for summarize_effects().

Member Data Documentation

◆ compute_max

bool scran_markers::SummarizeEffectsOptions::compute_max = true

Whether to report the maximum of the effect sizes for each group. Only affects the summarize_effects() overload that returns a vector of SummaryResults.

◆ compute_mean

bool scran_markers::SummarizeEffectsOptions::compute_mean = true

Whether to report the mean of the effect sizes for each group. Only affects the summarize_effects() overload that returns a vector of SummaryResults.

◆ compute_median

bool scran_markers::SummarizeEffectsOptions::compute_median = true

Whether to report the median of the effect sizes for each group. Only affects the summarize_effects() overload that returns a vector of SummaryResults.

◆ compute_min

bool scran_markers::SummarizeEffectsOptions::compute_min = true

Whether to report the minimum of the effect sizes for each group. Only affects the summarize_effects() overload that returns a vector of SummaryResults.

◆ compute_min_rank

bool scran_markers::SummarizeEffectsOptions::compute_min_rank = true

Whether to report the min-rank of the effect sizes for each group. Only affects the summarize_effects() overload that returns a vector of SummaryResults.

◆ compute_quantiles

std::optional<std::vector<double> > scran_markers::SummarizeEffectsOptions::compute_quantiles

Probabilites of the quantiles of the effect sizes for each group, to be reported. If set, the vector should be sorted and each entry should lie in \([0, 1]\). If not set, no quantiles are reported.

◆ min_rank_preserve_ties

bool scran_markers::SummarizeEffectsOptions::min_rank_preserve_ties = false

Whether to preserve ties when computing the minimum rank. If true, tied genes with equal effect sizes receive the same rank within each pairwise comparison. Otherwise, ties are broken in a stable manner, i.e., genes in earlier rows will receive a higher rank.

◆ num_threads

int scran_markers::SummarizeEffectsOptions::num_threads = 1

Number of threads to use. The parallelization scheme is determined by tatami::parallelize().

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

/github/workspace/include/scran_markers/summarize_effects.hpp

Public Attributes