scran_norm::ComputeMeanSizeFactorOptions Struct Reference

Options for compute_mean_size_factor() and compute_mean_size_factor_blocked(). More...

#include <center_size_factors.hpp>

Collaboration diagram for scran_norm::ComputeMeanSizeFactorOptions:

Public Attributes
bool	ignore_invalid = true
SizeFactorDiagnostics *	diagnostics = NULL

Detailed Description

Options for compute_mean_size_factor() and compute_mean_size_factor_blocked().

Member Data Documentation

ignore_invalid

bool scran_norm::ComputeMeanSizeFactorOptions::ignore_invalid = true

Whether to ignore invalid size factors when computing the mean size factor. Non-finite or non-positive size factors may occur in datasets that have not been properly filtered to remove low-quality cells. If such values might be present, we can check for and ignore them during the mean calculations. If users know that invalid size factors cannot be present, they can set this flag to false for greater efficiency.

diagnostics

SizeFactorDiagnostics* scran_norm::ComputeMeanSizeFactorOptions::diagnostics = NULL

Pointer to diagnostics for invalid size factors. On return of compute_mean_size_factor(), the referenced object is filled with diagnostics for invalid values in size_factors. It can also be NULL, in which case it is ignored.

Ignored if ComputeMeanSizeFactorOptions::ignore_invalid = false,

---

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

• scran_norm/center_size_factors.hpp