Options for per_cell_qc_metrics(). More...

#include <per_cell_qc_metrics.hpp>

Public Attributes
bool	compute_sum = true

bool	compute_detected = true

bool	compute_max_value = true

bool	compute_max_index = true

bool	compute_subset_sum = true

bool	compute_subset_detected = true

bool	subset_containers_have_indices = true

int	num_threads = 1

Detailed Description

Options for per_cell_qc_metrics().

Member Data Documentation

◆ compute_sum

bool scran_qc::PerCellQcMetricsOptions::compute_sum = true

Whether to compute the sum of expression values for each cell. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ compute_detected

bool scran_qc::PerCellQcMetricsOptions::compute_detected = true

Whether to compute the number of detected features for each cell. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ compute_max_value

bool scran_qc::PerCellQcMetricsOptions::compute_max_value = true

Whether to compute the maximum expression value for each cell. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ compute_max_index

bool scran_qc::PerCellQcMetricsOptions::compute_max_index = true

Whether to report the index of the feature with the maximum value for each cell. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ compute_subset_sum

bool scran_qc::PerCellQcMetricsOptions::compute_subset_sum = true

Whether to compute the sum expression in each feature subset. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ compute_subset_detected

bool scran_qc::PerCellQcMetricsOptions::compute_subset_detected = true

Whether to compute the number of detected features in each feature subset. This option only affects the per_cell_qc_metrics() overload that returns a PerCellQcMetricsResults object.

◆ subset_containers_have_indices

bool scran_qc::PerCellQcMetricsOptions::subset_containers_have_indices = true

Whether the subsets supplied to per_cell_qc_metrics() contain the row indices of the features within each subset.

This option is only relevant if Subset_ is not a pointer type. Instead, Subset_ is expected to be a container-like type with operator[], size, begin and end methods.

If true, each entry of subsets is assumed to be a container of unique row indices. This specifies the rows of the input matrix corresponding to the features in this subset..
If false, each entry of subsets is assumed to be a container of length equal to the number of features in the input matrix. Each container element is interpreted as a boolean indicating whether the corresponding row of the matrix belongs to the subset.

If Subset_ is a pointer type, this option is ignored. Each entry of subsets is assumed to be a pointer to an array of length equal to the number features in the input matrix, where each array element is treated as a boolean indicating whether the coresponding row of the matrix belongs to the subset.

◆ num_threads

int scran_qc::PerCellQcMetricsOptions::num_threads = 1

Number of threads to use. The parallelization scheme is determined by tatami::parallelize().

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

scran_qc/per_cell_qc_metrics.hpp

Public Attributes