AggregateAcrossCellsResults

AggregateAcrossCellsResults

Wrapper for the cell aggregation results, produced by aggregateAcrossCells.

Classes

AggregateAcrossCellsResults

Methods

allDetected(optionsopt) → {Float64Array|Float64WasmArray}

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

Optional parameters.

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

Whether to return a Float64Array. If false, a Float64WasmArray is returned instead. If not null, this should have the same length as the product of numberOfGenes and numberOfGroups.
Returns:

Array of length equal to the product of the number of genes and groups. This can be treated as a column-major matrix where the rows are the genes and the columns are the groups, and each element contains the number of detected cells for the corresponding gene in the corresponding group. If average = true in aggregateAcrossCells, each element is the proportion of detected cells instead. If buffer is supplied, the function returns buffer if asTypedArray = false, or a view on buffer if asTypedArray = true.

Type
Float64Array | Float64WasmArray

allSums(optionsopt) → {Float64Array|Float64WasmArray}

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

Optional parameters.

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

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

Buffer in which to store the output. If not null, this should have the same length as the product of numberOfGenes and numberOfGroups.
Returns:

Array of length equal to the product of the number of genes and groups. This can be treated as a column-major matrix where the rows are the genes and the columns are the groups, and each element is the sum of values for the corresponding gene in the corresponding group. If average = true in aggregateAcrossCells, each element is the mean value instead. If buffer is supplied, the function returns buffer if asTypedArray = false, or a view on buffer if asTypedArray = true.

Type
Float64Array | Float64WasmArray

free()

Source:
Returns:

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

groupDetected(group, optionsopt) → {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
group number

Index of the group. This should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

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

Copying mode to use, see possibleCopy for details.
Returns:

Array of length equal to the number of genes, containing the number of cells with detected expression for each gene in the specified group. If average = true in aggregateAcrossCells, each element is the proportion of detected cells instead.

Type
Float64Array | Float64WasmArray

groupSums(group, optionsopt) → {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
group number

Index of the group. This should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

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

Copying mode to use, see possibleCopy for details.
Returns:

Array of length equal to the number of genes, containing the per-gene sum of values across across all cells in the specified group. If average = true in aggregateAcrossCells, each element is the mean value instead.

Type
Float64Array | Float64WasmArray

numberOfGenes() → {number}

Source:
Returns:

Number of genes.

Type
number

numberOfGroups() → {number}

Source:
Returns:

Number of groups.

Type
number