Result store for QC metric calculations. More...

#include <PerCellAdtQcMetrics.hpp>

Public Member Functions
Buffers	buffers ()

Buffers< const double, const int >	buffers () const

Public Attributes
std::vector< double >	sums

std::vector< int >	detected

std::vector< std::vector< double > >	subset_totals

Detailed Description

Result store for QC metric calculations.

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

Member Function Documentation

◆ buffers() [1/2]

Buffers scran::PerCellAdtQcMetrics::Results::buffers ( )

inline

We assume that all members have already been allocated enough memory for use with PerCellAdtQcMetrics::run().

Returns: A Buffers object with appropriate pointers to the members of this Results instance.

◆ buffers() [2/2]

Buffers< const double, const int > scran::PerCellAdtQcMetrics::Results::buffers ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns: A Buffers object with const pointers to the members of this Results instance.

Member Data Documentation

◆ sums

std::vector<double> scran::PerCellAdtQcMetrics::Results::sums

Sum of counts for each cell.

◆ detected

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

Number of detected features in each cell.

◆ subset_totals

std::vector<std::vector<double> > scran::PerCellAdtQcMetrics::Results::subset_totals

Total count 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.

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

scran/quality_control/PerCellAdtQcMetrics.hpp

Public Member Functions

Public Attributes