PerCellCrisprQcMetricsResults

PerCellCrisprQcMetricsResults

Wrapper for the CRISPR-based metrics allocated on the Wasm heap, produced by perCellCrisprQcMetrics.

Classes

PerCellCrisprQcMetricsResults

Methods

detected(optionsopt) → (nullable) {Int32Array|Int32WasmArray}

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.
fillable boolean <optional>
 false

Whether to return a fillable array, to write to this object. If true, this method automatically sets copy = false if copy was previously true. If false and the array was not previously filled, null is returned.
Returns:

Array containing the total number of detected guides for each cell. Alternatively null, if fillable = false and the array was not already filled.

Type
Int32Array | Int32WasmArray

free()

Source:
Returns:

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

maxIndex(optionsopt) → (nullable) {Int32Array|Int32WasmArray}

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.
fillable boolean <optional>
 false

Whether to return a fillable array, to write to this object. If true, this method automatically sets copy = false if copy was previously true. If false and the array was not previously filled, null is returned.
Returns:

Array containing the index of the most abundant guide for each cell. Alternatively null, if fillable = false and the array was not already filled.

Type
Int32Array | Int32WasmArray

maxProportions(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.
fillable boolean <optional>
 false

Whether to return a fillable array, to write to this object. If true, this method automatically sets copy = false if copy was previously true. If false and the array was not previously filled, null is returned.
Returns:

Array containing the proportion of counts in the most abundant guide for each cell. Alternatively null, if fillable = false and the array was not already filled.

Type
Float64Array | Float64WasmArray

numberOfCells() → {number}

Source:
Returns:

Number of cells in this object.

Type
number

sums(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.
fillable boolean <optional>
 false

Whether to return a fillable array, to write to this object. If true, this method automatically sets copy = false if copy was previously true. If false and the array was not previously filled, null is returned.
Returns:

Array containing the total count across guides for each cell. Alternatively null, if fillable = false and the array was not already filled.

Type
Float64Array | Float64WasmArray