scran_qc::ComputeRnaQcMetricsBuffers< Sum_, Detected_, Proportion_ > Struct Template Reference

Buffers for compute_rna_qc_metrics(). More...

#include <rna_quality_control.hpp>

Public Attributes
Sum_ *	sum = NULL
Detected_ *	detected = NULL
std::vector< Proportion_ * >	subset_proportion

Detailed Description

template<typename Sum_ = double, typename Detected_ = int, typename Proportion_ = double>
struct scran_qc::ComputeRnaQcMetricsBuffers< Sum_, Detected_, Proportion_ >

Buffers for compute_rna_qc_metrics().

Template Parameters

Sum_	Numeric type of the sums, typically floating-point. If integer, this should be large enough to avoid overflow.
Detected_	Integer type of the number of detected cells. This should be large enough to avoid integer overflow.
Proportion_	Floating-point type of the proportions.

Note that, unlike PerCellQcMetricsBuffers, all pointers are expected to be non-NULL here.

Member Data Documentation

sum

template<typename Sum_ = double, typename Detected_ = int, typename Proportion_ = double>

Sum_* scran_qc::ComputeRnaQcMetricsBuffers< Sum_, Detected_, Proportion_ >::sum = NULL

Pointer to an array of length equal to the number of cells, to store the sum of counts in each cell. This is analogous to ComputeRnaQcMetricsResults::sum.

detected

template<typename Sum_ = double, typename Detected_ = int, typename Proportion_ = double>

Detected_* scran_qc::ComputeRnaQcMetricsBuffers< Sum_, Detected_, Proportion_ >::detected = NULL

Pointer to an array of length equal to the number of cells, to store the number of detected genes in each cell. This is analogous to ComputeRnaQcMetricsResults::detected.

subset_proportion

template<typename Sum_ = double, typename Detected_ = int, typename Proportion_ = double>

std::vector<Proportion_*> scran_qc::ComputeRnaQcMetricsBuffers< Sum_, Detected_, Proportion_ >::subset_proportion

Vector of pointers of length equal to the number of feature subsets. Each entry should point to an array of length equal to the number of cells, to store the subset proportion in each cell. This is analogous to ComputeRnaQcMetricsResults::subset_proportion.

---

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

• scran_qc/rna_quality_control.hpp