AggregateAcrossCellsResults

AggregateAcrossCellsResults

Wrapper for the cell aggregation results, produced by aggregateAcrossCells.

Classes

AggregateAcrossCellsResults

Methods

detected(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. This may also be null to obtain values for all groups.
options object <optional>
 {}

Optional parameters.

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

Copying mode to use when asMatrix = false, see possibleCopy for details.
Returns:

If group is a number, an array is returned where each entry corresponds to a gene and contains the number of detected cells in the specified group. If aggregateAcrossCells was run with average = true, each value is the proportion of cells with detected expression.

If group = null, an array is returned containing the concatenation of the arrays for all groups. If copy = "view", the output can be used in ScranMatrix.createDenseMatrix to create a ScranMatrix for input into other functions.

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.

numberOfGenes() → {number}

Source:
Returns:

Number of genes.

Type
number

numberOfGroups() → {number}

Source:
Returns:

Number of groups.

Type
number

sums(groupnullable, optionsopt) → {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
group number <nullable>

Index of the group. If a number, it should be non-negative and less than numberOfGroups. This may also be null to obtain values for all groups.
options object <optional>
 {}

Optional parameters.

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

Copying mode to use when asMatrix = false, see possibleCopy for details.
Returns:

If group is a number, an array is returned where each entry corresponds to a gene and contains the summed value across all cells in the specified group. If aggregateAcrossCells was run with average = true, the array contains the mean value instead of the sum.

If group = null, an array is returned containing the concatenation of the arrays for all groups. If copy = "view", the output can be used in ScranMatrix.createDenseMatrix to create a ScranMatrix for input into other functions.

Type
Float64Array | Float64WasmArray