INNER CODE UNIT · Python
load_example_data
scverse/PyDESeq2 · src/pydeseq2/datasets.py:11
def load_example_data(
modality: Literal["raw_counts", "metadata"] = "raw_counts",
dataset: Literal["synthetic"] = "synthetic",
debug: bool = False,
debug_seed: int = 42,
) -> pd.DataFrame:
"""Load synthetic example data.
May load either metadata or rna-seq data.
For now, this function may only return the synthetic data provided as part of this repo, but new datasets might be added in the future.
Parameters
----------
modality
Data modality. "raw_counts" or "metadata".
dataset
The dataset for which to return gene expression data.
If "synthetic", will return the synthetic data that is used for CI unit tests. (default: ``"synthetic"``).