diff --git a/doc/source/cookbook.rst b/doc/source/cookbook.rst index 12140bcc66403..20f6937cf8cf5 100644 --- a/doc/source/cookbook.rst +++ b/doc/source/cookbook.rst @@ -297,3 +297,26 @@ The :ref:`Timedeltas ` docs. `Operating with timedeltas `__ + +Aliasing Axis Names +------------------- + +To globally provide aliases for axis names, one can define these 2 functions: + +.. ipython:: python + + def set_axis_alias(cls, axis, alias): + if axis not in cls._AXIS_NUMBERS: + raise Exception("invalid axis [%s] for alias [%s]" % (axis, alias)) + cls._AXIS_ALIASES[alias] = axis + + def clear_axis_alias(cls, axis, alias): + if axis not in cls._AXIS_NUMBERS: + raise Exception("invalid axis [%s] for alias [%s]" % (axis, alias)) + cls._AXIS_ALIASES.pop(alias,None) + + + set_axis_alias(DataFrame,'columns', 'myaxis2') + df2 = DataFrame(randn(3,2),columns=['c1','c2'],index=['i1','i2','i3']) + df2.sum(axis='myaxis2') + clear_axis_alias(DataFrame,'columns', 'myaxis2')