SuggestRnaQcFiltersResults

SuggestRnaQcFiltersResults

Wrapper class for the filtering results, produced by computeSuggestRnaQcFilters.

Classes

SuggestRnaQcFiltersResults

Methods

detected(optionsopt) → {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

filter(metrics, optionsopt) → {Uint8Array|Uint8WasmArray}

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. block must be supplied if isBlocked returns true, otherwise it is ignored.
asTypedArray boolean <optional>
 true

Whether to return a Uint8Array. If false, a Uint8WasmArray is returned instead.
buffer Uint8WasmArray <optional>
<nullable>
 null

Array of length equal to the number of cells in metrics, to be used to store the high-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 high-quality based on its values in metrics. If buffer is supplied, the function returns buffer if asTypedArray = false, or a view on buffer if asTypedArray = true.

Type
Uint8Array | Uint8WasmArray

free()

Source:
Returns:

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

isBlocked() → {boolean}

Source:
Returns:

Whether blocking was used to compute the thresholds.

Type
boolean

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

subsetProportion(i, optionsopt) → {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.

Type
Float64Array | Float64WasmArray

sum(optionsopt) → {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.

Type
Float64Array | Float64WasmArray