larray.AxisCollection.rename¶
-
AxisCollection.
rename
(self, renames=None, to=None, **kwargs)[source]¶ Renames axes of the collection.
Parameters: - renames : axis ref or dict {axis ref: str} or list of tuple (axis ref, str), optional
Renames to apply. If a single axis reference is given, the to argument must be used.
- to : str or Axis, optional
New name if renames contains a single axis reference.
- **kwargs : str or Axis
New name for each axis given as a keyword argument.
Returns: - AxisCollection
collection with axes renamed.
Examples
>>> nat = Axis('nat=BE,FO') >>> sex = Axis('sex=M,F') >>> axes = AxisCollection([nat, sex]) >>> axes AxisCollection([ Axis(['BE', 'FO'], 'nat'), Axis(['M', 'F'], 'sex') ]) >>> axes.rename(nat, 'nat2') AxisCollection([ Axis(['BE', 'FO'], 'nat2'), Axis(['M', 'F'], 'sex') ]) >>> axes.rename(nat='nat2', sex='sex2') AxisCollection([ Axis(['BE', 'FO'], 'nat2'), Axis(['M', 'F'], 'sex2') ]) >>> axes.rename([('nat', 'nat2'), ('sex', 'sex2')]) AxisCollection([ Axis(['BE', 'FO'], 'nat2'), Axis(['M', 'F'], 'sex2') ]) >>> axes.rename({'nat': 'nat2', 'sex': 'sex2'}) AxisCollection([ Axis(['BE', 'FO'], 'nat2'), Axis(['M', 'F'], 'sex2') ])