dolomite_mae package

Submodules

dolomite_mae.read_multi_assay_experiment module

dolomite_mae.read_multi_assay_experiment.read_multi_assay_experiment(path, metadata, **kwargs)[source]

Load a MultiAssayExperiment 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:

MultiAssayExperiment

Returns:

A MultiAssayExperiment with file-backed arrays in the assays.

dolomite_mae.save_multi_assay_experiment module

dolomite_mae.save_multi_assay_experiment.save_multi_assay_experiment(x, path, data_frame_args=None, assay_args=None, **kwargs)[source]

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

Parameters:

  • x (MultiAssayExperiment) – 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.

  • kwargs – Further arguments.

Returns:

x is saved to path.

Module contents