mosaicmpi.integration.Integration.get_metadata_df

mosaicmpi.integration.Integration.get_metadata_df#

Integration.get_metadata_df(include_categorical: bool = True, include_numerical: bool = True, prepend_dataset_column: bool = False, subset_datasets: str | Iterable[str] | None = None) → DataFrame#

Get sample/observation metadata for all datasets.

Parameters:

  • include_categorical (bool, optional) – Include categorical metadata layers, defaults to True

  • include_numerical (bool, optional) – Include numerical metadata layers, defaults to True

  • prepend_dataset_column (bool, optional) – Prepend dataframe with dataset name column, defaults to False

  • subset_datasets (str or Iterable[str], optional) – dataset name or iterable of dataset names to subset the results, defaults to None

Returns:

observations × metadata matrix

Return type:

pd.DataFrame

Contents