scran_markers::SummarizeEffectsOptions Struct Reference

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

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.

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