skbio.util.aliased#

skbio.util.aliased(name, ver=None, warn=False)[source]#

Create an alias for a function or method.

Parameters:

namestr: Alias name of the function or method.
verstr, optional: Version when alias was created.
warnbool, optional: If True, raise a deprecation warning when alias is called.

See also

deprecated
register_aliases
params_aliased

Notes

This is a decorator that can be applied to a function or method to indicate its alias status. To make it effective, register_aliases must be applied to the parent module or class.