ZippedAlabasterResult

ZippedAlabasterResult

Result as a ZIP file containing a SummarizedExperiment in the alabaster representation, Specifically, the ZIP file should contain the contents of an alabaster project directory. This project directory may contain multiple objects; the SummarizedExperiment of interest is identified in the constructor.

Constructor

new ZippedAlabasterResult(prefix, zipfile, optionsopt)

Source:
Parameters:
Name Type Attributes Default Description
prefix string

Name of the SummarizedExperiment object inside the project directory.
zipfile SimpleFile | string | File

Contents of the ZIP file containing the project directory. On browsers, this may be a File object. On Node.js, this may also be a string containing a file path.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
existingHandle JSZip <optional>
<nullable>
 null

An existing handle into the ZIP file, generated using the JSZip package. If an existing handle already exists, passing it in here will allow it to be re-used for greater efficiency. If null, a new handle is created for this ZippedAlabasterDataset instance.

Extends

Classes

ZippedAlabasterResult

Methods

clear()

Description:

  • Destroy caches if present, releasing the associated memory. This may be called at any time but only has an effect if cache = true in load or summary.

Source:
Overrides:

(async) load(optionsopt) → {object}

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

Optional parameters.

Properties
Name Type Attributes Default Description
cache boolean <optional>
 false

Whether to cache the results for re-use in subsequent calls to this method or summary. If true, users should consider calling clear to release the memory once this dataset instance is no longer needed.
Returns:

Object containing the per-feature and per-cell annotations. This has the following properties:

  • features: an object where each key is a modality name and each value is a DataFrame of per-feature annotations for that modality.
  • cells: a DataFrame containing per-cell annotations.
  • matrix: a MultiMatrix containing one ScranMatrix per modality.
  • reduced_dimensions: an object containing the dimensionality reduction results. Each value is an array of arrays, where each inner array contains the coordinates for one dimension.

If the main experiment is unnamed, its modality name is set to an empty string. If the main experiment's name is the same as any alternative experiment name, the former will be reported in the returned objects.

Type
object

options() → {object}

Source:
Overrides:
Returns:

Object containing all options used for loading.

Type
object

setOptions(options)

Source:
Overrides:
Parameters:
Name Type Description
options object

Optional parameters that affect load (but not summary.

Properties
Name Type Attributes Description
primaryAssay object | string | number <optional>

Assay containing the relevant data for each modality.

  • If a string, this is used as the name of the assay across all modalities.
  • If a number, this is used as the index of the assay across all modalities.
  • If any object, the key should be the name of a modality and the value may be either a string or number specifying the assay to use for that modality. Modalities absent from this object will not be loaded.
isPrimaryNormalized object | boolean <optional>

Whether or not the assay for a particular modality has already been normalized.

  • If a boolean, this is used to indicate normalization status of assays across all modalities. If false, that modality's assay is assumed to contain count data and is subjected to library size normalization.
  • If any object, the key should be the name of a modality and the value should be a boolean indicating whether that modality's assay has been normalized. Modalities absent from this object are assumed to have been normalized.
reducedDimensionNames Array <optional>
<nullable>

Array of names of the reduced dimensions to load. If null, all reduced dimensions found in the file are loaded.

(async) summary(optionsopt) → {object}

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

Optional parameters.

Properties
Name Type Attributes Default Description
cache boolean <optional>
 false

Whether to cache the results for re-use in subsequent calls to this method or load. If true, users should consider calling clear to release the memory once this dataset instance is no longer needed.
Returns:

Object containing the per-feature and per-cell annotations. This has the following properties:

  • modality_features: an object where each key is a modality name and each value is a DataFrame of per-feature annotations for that modality.
  • cells: a DataFrame of per-cell annotations.
  • modality_assay_names: an object where each key is a modality name and each value is an Array containing the names of available assays for that modality. Unnamed assays are represented as null names.
  • reduced_dimension_names: an Array of strings containing names of dimensionality reduction results.

If the main experiment is unnamed, its modality name is set to an empty string. If the main experiment's name is the same as any alternative experiment name, the former will be reported in the returned objects.

Type
object