PerCellCrisprQcMetricsResults

PerCellCrisprQcMetricsResults

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

Classes

PerCellCrisprQcMetricsResults

Methods

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

Array containing the total number of detected guides for each cell.

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) → {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.
Returns:

Array containing the index of the most abundant guide for each cell.

Type
Int32Array | Int32WasmArray

maxProportion() → {Float64Array}

Source:
Returns:

Array containing the proportion of counts in the most abundant guide for each cell.

Type
Float64Array

maxValue(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.
Returns:

Array containing the count of the most abundant guide for each cell.

Type
Float64Array | Float64WasmArray

numberOfCells() → {number}

Source:
Returns:

Number of cells in this object.

Type
number

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.
Returns:

Array containing the total count across guides for each cell.

Type
Float64Array | Float64WasmArray