mudata.settings

mudata.settings = _Settings(display_style='text', display_html_expand=2, pull_on_update=False)

Allows users to customize settings for the mudata package.

Settings here will generally be for advanced use-cases and should be used with caution.

For setting an option use override() (local) or set the attributes directly (global) e.g., mudata.settings.my_setting = foo. For assignment by environment variable, use the variable name in all caps with MUDATA_ as the prefix before import of mudata.

The following options are available:

settings.display_style: Literal['text', 'html'] = 'text'

MuData object representation to use in notebooks.

settings.display_html_expand: int = 2

3-bit flag influencing whether to expand MuData slots when using HTML representation. - 0x4: expand MuData slots - 0x2: expand .mod slots - 0x1: expand slots for each modality

settings.pull_on_update: bool = False

Whether to pull columns from modalities into the global .obs/.var when running MuData.update().