Source code for dolomite_se.save_summarized_experiment

import os

import dolomite_base as dl
from summarizedexperiment import SummarizedExperiment

from .utils import save_common_se_props




@dl.save_object.register
@dl.validate_saves
def save_summarized_experiment(
    x: SummarizedExperiment,
    path: str,
    data_frame_args: dict = None,
    assay_args: dict = None,
    **kwargs,
):
    """Method for saving
    :py:class:`~summarizedexperiment.SummarizedExperiment.SummarizedExperiment`
    objects to their corresponding file representations, see
    :py:meth:`~dolomite_base.save_object.save_object` for details.

    Args:
        x:
            Object to be staged.

        path:
            Path to a directory in which to save ``x``.

        data_frame_args:
            Further arguments to pass to the ``save_object`` method for the
            row/column data.

        assay_args:
            Further arguments to pass to the ``save_object`` method for the
            assays.

        kwargs:
            Further arguments.

    Returns:
        ``x`` is saved to path.
    """
    os.mkdir(path)

    if data_frame_args is None:
        data_frame_args = {}

    if assay_args is None:
        assay_args = {}

    save_common_se_props(
        x, path, data_frame_args=data_frame_args, assay_args=assay_args, **kwargs
    )

    return