skbio.util.set_config#

skbio.util.set_config(option: str, value: str)[source]#

Set a scikit-bio config option.

This function enables users to set the configuration of scikit-bio functions globally.

Parameters:

optionstr: The configuration option to be modified. Currently there is only one configurable option, "output".
valuestr: The value to update the configuration dictionary with. For the "output" option, value may be set to "pandas", "polars", or "numpy". Defaults to "pandas".

Raises:

ValueError: If an unkown option is used or if an unsupported value for an option is used.

Examples

>>> from skbio import set_config
>>> set_config("output", "numpy")