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

Results of compute_crispr_qc_metrics(). More...

#include <crispr_quality_control.hpp>

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

Detailed Description

template<typename Sum_ = double, typename Detected_ = int, typename Value_ = double, typename Index_ = int>
struct scran_qc::ComputeCrisprQcMetricsResults< Sum_, Detected_, Value_, Index_ >

Results of compute_crispr_qc_metrics().

Template Parameters

Sum_	Numeric type of the sums, usually 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, typically set to the same type as Index_.
Value_	Type of matrix value.
Index_	Type of the matrix indices.

Meaningful instances of this object should generally be constructed by calling the compute_crispr_qc_metrics() function.

Member Data Documentation

sum

template<typename Sum_ = double, typename Detected_ = int, typename Value_ = double, typename Index_ = int>

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

Vector of length equal to the number of cells in the dataset, containing the sum of counts for each cell.

detected

template<typename Sum_ = double, typename Detected_ = int, typename Value_ = double, typename Index_ = int>

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

Vector of length equal to the number of cells in the dataset, containing the number of detected features in each cell.

max_value

template<typename Sum_ = double, typename Detected_ = int, typename Value_ = double, typename Index_ = int>

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

Vector of length equal to the number of cells in the dataset, containing the maximum count for each cell.

max_index

template<typename Sum_ = double, typename Detected_ = int, typename Value_ = double, typename Index_ = int>

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

Vector of length equal to the number of cells in the dataset, containing the row index of the guide with the maximum count for each cell.

---

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

• scran_qc/crispr_quality_control.hpp