ehrapy.settings.override

ehrapy.settings.override#

settings.override(*, plot_suffix=<no change>, file_format_data=<no change>, file_format_figs=<no change>, autosave=<no change>, autoshow=<no change>, writedir=<no change>, cachedir=<no change>, datasetdir=<no change>, figdir=<no change>, cache_compression=<no change>, max_memory=<no change>, n_jobs=<no change>, categories_to_ignore=<no change>, n_pcs=<no change>)#

Provides local override via keyword arguments as a context manager.

Parameters:
  • verbosity (Literal['error', 'warning', 'success', 'info', 'hint', 'debug'], default: <no change>) – Logger verbosity (one of 'error', 'warning', 'success', 'info', 'hint', 'debug').

  • plot_suffix (str, default: <no change>) – Global suffix appended to figure filenames.

  • file_format_data (Literal['csv', 'h5ad'], default: <no change>) – File format for saving EHRData objects.

  • file_format_figs (str, default: <no change>) – Default file format for saving figures (e.g. 'png', 'pdf', 'svg').

  • autosave (bool, default: <no change>) – Automatically save figures to figdir instead of displaying them.

  • autoshow (bool, default: <no change>) – Automatically show figures when autosave is False.

  • writedir (Path, default: <no change>) – Default directory for scanpy.write().

  • cachedir (Path, default: <no change>) – Directory for cache files.

  • datasetdir (Path, default: <no change>) – Directory for downloaded example datasets.

  • figdir (Path, default: <no change>) – Directory for saving figures.

  • cache_compression (Literal['lzf', 'gzip'] | None, default: <no change>) – Compression for cached reads.

  • max_memory (float, default: <no change>) – Maximum memory usage in Gigabytes (advisory).

  • n_jobs (int, default: <no change>) – Default number of jobs / CPUs for parallel computing. -1 uses all available cores.

  • categories_to_ignore (list[str], default: <no change>) – Category labels omitted in plotting.

  • n_pcs (int, default: <no change>) – Default number of principal components.

Return type:

AbstractContextManager[None]