scran_markers::SummaryBuffers< Stat_, Rank_ > Struct Template Reference

Pointers to arrays to hold the summary statistics. More...

#include <summarize_comparisons.hpp>

Public Attributes
Stat_ *	min = NULL
Stat_ *	mean = NULL
Stat_ *	median = NULL
Stat_ *	max = NULL
std::optional< std::vector< Stat_ * > >	quantiles
Rank_ *	min_rank = NULL

Detailed Description

template<typename Stat_ = double, typename Rank_ = int>
struct scran_markers::SummaryBuffers< Stat_, Rank_ >

Pointers to arrays to hold the summary statistics.

Template Parameters

Stat_	Floating-point type of the statistics.
Rank_	Numeric type of the rank.

Member Data Documentation

max

template<typename Stat_ = double, typename Rank_ = int>

Stat_* scran_markers::SummaryBuffers< Stat_, Rank_ >::max = NULL

Pointer to an array of length equal to the number of genes, to be filled with the maximum effect size for each gene. If NULL, the maximum is not computed.

mean

template<typename Stat_ = double, typename Rank_ = int>

Stat_* scran_markers::SummaryBuffers< Stat_, Rank_ >::mean = NULL

Pointer to an array of length equal to the number of genes, to be filled with the mean effect size for each gene. If NULL, the mean is not computed.

median

template<typename Stat_ = double, typename Rank_ = int>

Stat_* scran_markers::SummaryBuffers< Stat_, Rank_ >::median = NULL

Pointer to an array of length equal to the number of genes, to be filled with the median effect size for each gene. If NULL, the median is not computed.

min

template<typename Stat_ = double, typename Rank_ = int>

Stat_* scran_markers::SummaryBuffers< Stat_, Rank_ >::min = NULL

Pointer to an array of length equal to the number of genes, to be filled with the minimum effect size for each gene. If NULL, the minimum is not computed.

min_rank

template<typename Stat_ = double, typename Rank_ = int>

Rank_* scran_markers::SummaryBuffers< Stat_, Rank_ >::min_rank = NULL

Pointer to an array of length equal to the number of genes, to be filled with the minimum rank of the effect sizes for each gene. If NULL, the minimum rank is not computed.

quantiles

template<typename Stat_ = double, typename Rank_ = int>

std::optional<std::vector<Stat_*> > scran_markers::SummaryBuffers< Stat_, Rank_ >::quantiles

Optional vector of pointers to arrays of length equal to the number of genes. Each pointer corresponds to a quantile probability from SummarizeEffects::compute_quantiles. The array is to be filled with the corresponding quantile of effect sizes for each gene.

If unset, no quantiles will be computed computed. If set, each pointer should be non-NULL, and the length of the vector should be equal to:

• the vector stored in SummarizeEffectsOptions::compute_quantiles, if the SummaryBuffers object is to be passed to summarize_effects(). If no vector was stored, quantiles is ignored.
• the vector stored in ScoreMarkersSummaryOptions::compute_summary_quantiles, if the SummaryBuffers object is to be passed to score_markers_summary(). If no vector was stored, quantiles is ignored.

---

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

• /github/workspace/include/scran_markers/summarize_comparisons.hpp