ScoreMarkersResults

ScoreMarkersResults

Wrapper around the marker scoring results on the Wasm heap, typically produced by scoreMarkers.

Classes

ScoreMarkersResults

Methods

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

Source:

AUCs are only computed if computeAuc = true in scoreMarkers. If false, this method will throw an error.

Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
summary string <optional>
 "mean"

Summary statistic to be computed from the AUCs of all pairwise comparisons involving group. This can be the "minimum" across comparisons, "mean" or "min-rank". If the relevant options are set in scoreMarkers, "maximum" and "median" are also supported.
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 summarized AUC for the comparisons between group and all other groups.

Type
Float64Array | Float64WasmArray

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

Source:
Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
summary string <optional>
 "mean"

Summary statistic to be computed from the Cohen's d values of all pairwise comparisons involving group. This can be the "minimum" across comparisons, "mean" or "min-rank". If the relevant options are set in scoreMarkers, "maximum" and "median" are also supported.
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 summarized Cohen's d for the comparisons between group and all other groups.

Type
Float64Array | Float64WasmArray

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

Source:
Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
summary string <optional>
 "mean"

Summary statistic to be computed from the delta-detected values of all pairwise comparisons involving group. This can be the "minimum" across comparisons, "mean" or "min-rank". If the relevant options are set in scoreMarkers, "maximum" and "median" are also supported.
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 summarized delta-detected for the comparisons between group and all other groups.

Type
Float64Array | Float64WasmArray

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

Source:
Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
summary string <optional>
 "mean"

Summary statistic to be computed from the log-fold changes of all pairwise comparisons involving group. This can be the "minimum" across comparisons, "mean" or "min-rank". If the relevant options are set in scoreMarkers, "maximum" and "median" are also supported.
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 summarized delta-mean for the comparisons between group and all other groups. This can be interpreted as the log-fold change if log-expression values are used in scoreMarkers.

Type
Float64Array | Float64WasmArray

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

Source:
Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
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 of length equal to the number of genes, containing the proportion of cells with detectable expression for the requested group in the requested block.

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.

mean(group, optionsopt) → (nullable) {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
group number

Group of interest. Should be non-negative and less than numberOfGroups.
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 of length equal to the number of genes, containing the mean expression for the requested group in the requested block.

Type
Float64Array | Float64WasmArray

numberOfGroups() → {number}

Source:
Returns:

Number of groups in the results.

Type
number