Result store for QC metric calculations. More...

#include <PerCellCrisprQcMetrics.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< double >	max_proportion

std::vector< int >	max_index

Detailed Description

Result store for QC metric calculations.

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

Member Function Documentation

◆ buffers() [1/2]

Buffers scran::PerCellCrisprQcMetrics::Results::buffers ( )

inline

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

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

◆ buffers() [2/2]

Buffers< const double, const int > scran::PerCellCrisprQcMetrics::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::PerCellCrisprQcMetrics::Results::sums

Sum of counts for each cell.

◆ detected

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

Number of detected features in each cell.

◆ max_proportion

std::vector<double> scran::PerCellCrisprQcMetrics::Results::max_proportion

Proportion of counts in the most abundant guide.

◆ max_index

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

Index of the most abundant guide.

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

scran/quality_control/PerCellCrisprQcMetrics.hpp

Public Member Functions

Public Attributes