scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ > Struct Template Reference

Result store for QC metric calculations. More...

#include <per_cell_qc_metrics.hpp>

Public Attributes
std::vector< Sum_ >	sum
std::vector< Detected_ >	detected
std::vector< Index_ >	max_index
std::vector< Value_ >	max_value
std::vector< std::vector< Sum_ > >	subset_sum
std::vector< std::vector< Detected_ > >	subset_detected

Detailed Description

template<typename Sum_, typename Detected_, typename Value_, typename Index_>
struct scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >

Result store for QC metric calculations.

Template Parameters

Sum_	Floating point type to store the sums.
Detected_	Integer type to store the number of detected cells.
Value_	Type of the matrix value.
Index_	Integer type to store the gene index.

Meaningful instances of this object should generally be constructed by calling the per_cell_qc_metrics() functions. Empty instances can be default-constructed as placeholders.

Member Data Documentation

sum

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Sum_> scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::sum

Sum of expression values for each cell. Empty if PerCellQcMetricsOptions::compute_sum is false.

detected

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Detected_> scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::detected

Number of detected features in each cell. Empty if PerCellQcMetricsOptions::compute_detected is false.

max_index

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Index_> scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::max_index

Row index of the most-expressed feature in each cell. On ties, the first feature is arbitrarily chosen. Empty if PerCellQcMetricsOptions::compute_max_index is false.

max_value

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Value_> scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::max_value

Maximum value in each cell. Empty if PerCellQcMetricsOptions::compute_max_value is false.

subset_sum

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<std::vector<Sum_> > scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::subset_sum

Sum of expression values for each feature subset in each cell. Each inner vector corresponds to a feature subset and is of length equal to the number of cells. Empty if there are no feature subsets or if PerCellQcMetricsOptions::compute_subset_sum is false.

subset_detected

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<std::vector<Detected_> > scran_qc::PerCellQcMetricsResults< Sum_, Detected_, Value_, Index_ >::subset_detected

Number of detected features in each feature subset in each cell. Each inner vector corresponds to a feature subset and is of length equal to the number of cells. Empty if there are no feature subsets or if PerCellQcMetricsOptions::compute_subset_detected is false.

---

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

• scran_qc/per_cell_qc_metrics.hpp