topicks::PickTopGenesOptions< Stat_ > Struct Template Reference

Options for pick_top_genes(). More...

#include <topicks.hpp>

Public Attributes
std::optional< Stat_ >	bound
bool	keep_ties = true

Detailed Description

template<typename Stat_>
struct topicks::PickTopGenesOptions< Stat_ >

Options for pick_top_genes().

Template Parameters

Stat_

Numeric type of the statistic for picking top genes.

Member Data Documentation

bound

template<typename Stat_ >

std::optional<Stat_> topicks::PickTopGenesOptions< Stat_ >::bound

A absolute bound for the statistic, to be considered when choosing the top genes. A gene with a lower (if PickTopGenesOptions::larger = false) or higher statistic (otherwise) will not be picked even if it is among the top top genes. If unset, no absolute bound is applied to the statistic.

keep_ties

template<typename Stat_ >

bool topicks::PickTopGenesOptions< Stat_ >::keep_ties = true

Whether to keep all genes with statistics that are tied with the PickTopGenesOptions::top-th gene. If false, ties are arbitrarily broken but the number of retained genes will not be greater than PickTopGenesOptions::top.

---

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

• topicks/topicks.hpp