ModelGeneVariancesResults

Wrapper for the variance modelling results, produced by modelGeneVar.

Classes

ModelGeneVariancesResults

Methods

fitted(optionsopt) → {Float64Array|Float64WasmArray}

Source:

modelGeneVariances.js, line 65

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`block`	number	<optional> <nullable>	`null`	Number of the block for which to extract statistics. If `null`, the average across all blocks is returned. Otherwise, should be less than the value returned by `numberOfBlocks`. Ignored if `isBlocked` returns false.
`copy`	boolean	<optional>	`true`	Whether to copy the results from the Wasm heap, see `possibleCopy`.

Returns:

Array of length equal to the number of genes, containing the fitted value of the mean-variance trend for the specified block (or the average across all blocks, if block = null).

Type: Float64Array | Float64WasmArray

free()

Source:

modelGeneVariances.js, line 107

Returns:

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

isBlocked() → {boolean}

Source:

modelGeneVariances.js, line 99

Returns:

Whether blocking was used during trend fitting.

Type: boolean

means(optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:

modelGeneVariances.js, line 29

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`block`	number	<optional> <nullable>	`null`	Number of the block for which to extract statistics. If `null`, the average across all blocks is returned. Otherwise, should be less than the value returned by `numberOfBlocks`. Ignored if `isBlocked` returns false.
`copy`	boolean	<optional>	`true`	Whether to copy the results from the Wasm heap, see `possibleCopy`.

Returns:

Array of length equal to the number of genes, containing the mean log-expression across all cells in the specified block (or the average across all blocks, if block = null).

Type: Float64Array | Float64WasmArray

numberOfBlocks() → {number}

Source:

modelGeneVariances.js, line 92

Returns:

Number of blocks used.

Type: number

residuals(optionsopt) → {Float64Array|Float64WasmArray}

Source:

modelGeneVariances.js, line 83

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`block`	number	<optional> <nullable>	`null`	Number of the block for which to extract statistics. If `null`, the average across all blocks is returned. Otherwise, should be less than the value returned by `numberOfBlocks`. Ignored if `isBlocked` returns false.
`copy`	boolean	<optional>	`true`	Whether to copy the results from the Wasm heap, see `possibleCopy`.

Returns:

Array of length equal to the number of genes, containing the residuals from the mean-variance trend for the specified block (or the average across all blocks, if block = null).

Type: Float64Array | Float64WasmArray

variances(optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:

modelGeneVariances.js, line 47

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`block`	number	<optional> <nullable>	`null`	Number of the block for which to extract statistics. If `null`, the average across all blocks is returned. Otherwise, should be less than the value returned by `numberOfBlocks`. Ignored if `isBlocked` returns false.
`copy`	boolean	<optional>	`true`	Whether to copy the results from the Wasm heap, see `possibleCopy`.

Returns:

Array of length equal to the number of genes, containing the variance of log-expression across all cells in the specified block (or the average across all blocks, if block = null).

Type: Float64Array | Float64WasmArray