SuggestRnaQcFiltersResults

SuggestRnaQcFiltersResults

Wrapper class for the filtering results, produced by computeSuggestRnaQcFilters.

Classes

SuggestRnaQcFiltersResults

Methods

filter(metrics, optionsopt) → {Uint8Array}

Source:
Parameters:
Name Type Attributes Default Description
metrics PerCellRnaQcMetricsResults

Per-cell QC metrics, usually computed by perCellRnaQcMetrics.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
block Int32WasmArray | Array | TypedArray <optional>
<nullable>
 null

Array containing the block assignment for each cell in metrics. This should have length equal to the number of cells and contain all values in [0, n) where n is the return value of numberOfBlocks.

Alternatively, this may be null, in which case all cells are assumed to be in the same block. This will raise an error if multiple blocks were used to compute the thresholds.
buffer Uint8WasmArray <optional>
<nullable>
 null

Array of length equal to the number of cells in metrics, to be used to store the low-quality calls.
Returns:

Array of length equal to the number of cells in metrics. Each entry is truthy if the corresponding cell is deemed to be of low-quality based on its values in metrics. If buffer is supplied, the returned array is a view on buffer.

Type
Uint8Array

free()

Source:
Returns:

Frees the memory allocated on the Wasm heap for this object. This invalidates this object and all references to it.

numberOfBlocks() → {number}

Source:
Returns:

Number of blocks in this object.

Type
number

numberOfSubsets() → {number}

Source:
Returns:

Number of feature subsets in this object.

Type
number

thresholdsDetected(optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
 true

Whether to copy the results from the Wasm heap, see possibleCopy. This should be set to false or "view" to modify entries, e.g., after calling creating an instance with emptySuggestRnaQcFiltersResults.
Returns:

Array containing the filtering threshold on the number of detected genes for each batch.

Type
Float64Array | Float64WasmArray

thresholdsSubsetProportions(i, optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
i number

Index of the feature subset of interest.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
 true

Whether to copy the results from the Wasm heap, see possibleCopy. This should be set to false or "view" to modify entries, e.g., after calling creating an instance with emptySuggestRnaQcFiltersResults.
Returns:

Array containing the filtering threshold on the proportions for subset i in each batch. Alternatively null, if fillable = false and the array was not already filled.

Type
Float64Array | Float64WasmArray

thresholdsSums(optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
 true

Whether to copy the results from the Wasm heap, see possibleCopy. This should be set to false or "view" to modify entries, e.g., after calling creating an instance with emptySuggestRnaQcFiltersResults.
Returns:

Array containing the filtering threshold on the sums for each batch. Alternatively null, if fillable = false and the array was not already filled.

Type
Float64Array | Float64WasmArray