pandas.CategoricalIndex.reorder_categories#

CategoricalIndex.reorder_categories(new_categories, ordered=None)[source]#

Reorder categories as specified in new_categories.

new_categories need to include all old categories and no new category items.

Parameters:

new_categoriesIndex-like: The categories in new order.
orderedbool, optional: Whether or not the categorical is treated as an ordered categorical. If not given, do not change the ordered information.

Returns:

CategoricalIndex: CategoricalIndex with reordered categories.

Raises:

ValueError: If the new categories do not contain all old category items or any new ones

See also

CategoricalIndex.rename_categories: Rename categories.
CategoricalIndex.add_categories: Add new categories.
CategoricalIndex.remove_categories: Remove the specified categories.
CategoricalIndex.remove_unused_categories: Remove categories which are not used.
CategoricalIndex.set_categories: Set the categories to the specified ones.

Examples

>>> ci = pd.CategoricalIndex(["a", "b", "c", "a"])
>>> ci
CategoricalIndex(['a', 'b', 'c', 'a'], categories=['a', 'b', 'c'],
                 ordered=False, dtype='category')
>>> ci.reorder_categories(["c", "b", "a"], ordered=True)
CategoricalIndex(['a', 'b', 'c', 'a'], categories=['c', 'b', 'a'],
                 ordered=True, dtype='category')