scran::PerCellQcMetrics::Results Struct Reference

Result store for QC metric calculations. More...

#include <PerCellQcMetrics.hpp>

Public Attributes
std::vector< double >	total
std::vector< int >	detected
std::vector< int >	max_index
std::vector< double >	max_count
std::vector< std::vector< double > >	subset_total
std::vector< std::vector< int > >	subset_detected

Detailed Description

Result store for QC metric calculations.

Meaningful instances of this object should generally be constructed by calling the PerCellRnaQcMetrics::run() methods. Empty instances can be default-constructed as placeholders.

Member Data Documentation

total

std::vector<double> scran::PerCellQcMetrics::Results::total

Total count for each cell. Empty if PerCellQcMetrics::compute_total is false.

detected

std::vector<int> scran::PerCellQcMetrics::Results::detected

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

max_index

std::vector<int> scran::PerCellQcMetrics::Results::max_index

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

max_count

std::vector<double> scran::PerCellQcMetrics::Results::max_count

Maximum count value in each cell. Empty if PerCellQcMetrics::compute_max_count is false.

subset_total

std::vector<std::vector<double> > scran::PerCellQcMetrics::Results::subset_total

Total count of 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 PerCellQcMetrics::compute_subset_total is false.

subset_detected

std::vector<std::vector<int> > scran::PerCellQcMetrics::Results::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 PerCellQcMetrics::compute_subset_detected is false.

---

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

• scran/quality_control/PerCellQcMetrics.hpp