dolomite_sce package

Submodules

dolomite_sce.read_single_cell_experiment module

dolomite_sce.read_single_cell_experiment.read_single_cell_experiment(path, metadata, **kwargs)

Load a SingleCellExperiment from its on-disk representation.

This method should generally not be called directly but instead be invoked by read_object().

Parameters:

• path (str) – Path to the directory containing the object.

• metadata (dict) – Metadata for the object.

• kwargs – Further arguments.

Return type:

SingleCellExperiment

Returns:

A SingleCellExperiment with file-backed arrays in the assays.

dolomite_sce.save_single_cell_experiment module

dolomite_sce.save_single_cell_experiment.save_single_cell_experiment(x, path, data_frame_args=None, assay_args=None, rdim_args=None, alt_expts_args=None, **kwargs)

Method for saving SingleCellExperiment objects to their corresponding file representations, see save_object() for details.

Parameters:

• x (SingleCellExperiment) – Object to be staged.

• path (str) – Path to a directory in which to save x.

• data_frame_args (dict) – Further arguments to pass to the save_object method for the row/column data.

• assay_args (dict) – Further arguments to pass to the save_object method for the assays.

• rdim_args (dict) – Further arguments to pass to the save_object method for the reduced dimensions.

• alt_expts_args (dict) – Further arguments to pass to the save_object method for the alternative experiments.

• kwargs – Further arguments.

Returns:

x is saved to path.

Module contents