topicks
Pick top genes for downstream analyses
|
Options for pick_top_genes()
.
More...
#include <pick_top_genes.hpp>
Public Attributes | |
std::optional< Stat_ > | bound |
bool | open_bound = true |
bool | keep_ties = true |
bool | check_nan = false |
Options for pick_top_genes()
.
Stat_ | Numeric type of the statistic for picking top genes. |
std::optional<Stat_> topicks::PickTopGenesOptions< Stat_ >::bound |
A absolute bound for the statistic, to be considered when choosing the top genes. A gene will not be picked, even if it is among the top top
genes, if its statistic is:
larger = true
and PickTopGenesOptions::open_bound = true
.larger = true
and PickTopGenesOptions::open_bound = false
.larger = false
and PickTopGenesOptions::open_bound = true
.larger = false
and PickTopGenesOptions::open_bound = false
.If unset, no absolute bound is applied to the statistic.
bool topicks::PickTopGenesOptions< Stat_ >::open_bound = true |
Whether PickTopGenesOptions::bound
is an open interval, i.e., genes with statistics equal to the bound will not be picked. Only relevant if PickTopGenesOptions::bound
is set.
bool topicks::PickTopGenesOptions< Stat_ >::keep_ties = true |
Whether to keep all genes with statistics that are tied with the top
-th gene. If false
, ties are arbitrarily broken but the number of retained genes will not be greater than top
.
bool topicks::PickTopGenesOptions< Stat_ >::check_nan = false |
Whether to check for NaN values and ignore them. If false
, it is assumed that no NaNs are present in statistic
.