AdtNormalizationState

AdtNormalizationState

This step performs normalization and log-transformation on the QC-filtered ADT matrix from the CellFilteringState. It wraps the groupedSizeFactors and normalizeCounts functions from scran.js.

Methods not documented here are not part of the stable API and should not be used by applications.

Classes

AdtNormalizationState

Methods

compute(parameters)

Description:

  • This method should not be called directly by users, but is instead invoked by runAnalysis.

Source:
Parameters:
Name Type Description
parameters object

Parameter object, equivalent to the adt_normalization property of the parameters of runAnalysis.

Properties
Name Type Attributes Description
remove_bias boolean <optional>

Whether to remove composition bias between cell subpopulations via the CLRm1 method. Users can set this to false to speed up the compute, at the cost of retaining biases in downstream steps.
Returns:

The object is updated with new results.

fetchNormalizedMatrix() → {external:ScranMatrix}

Source:
Returns:

A ScranMatrix object containing the normalized ADT values, available after running compute.

Type
external:ScranMatrix

fetchParameters() → {object}

Source:
Returns:

Object containing the parameters, available after running compute.

Type
object

fetchSizeFactors() → {Float64WasmArray}

Source:
Returns:

Array of length equal to the number of cells, containing the ADT-derived size factor for each cell in the (QC-filtered) dataset. This is available after running compute.

Type
Float64WasmArray

(static) defaults() → {object}

Source:
Returns:

Object containing default parameters, see the parameters argument in compute for details.

Type
object