pandas.CategoricalIndex.remove_categories

CategoricalIndex.remove_categories(*args, **kwargs)

Remove the specified categories.

removals must be included in the old categories. Values which were in the removed categories will be set to NaN

Parameters:

removalscategory or list of categories

The categories which should be removed.

inplacebool, default False

Whether or not to remove the categories inplace or return a copy of this categorical with removed categories.

Deprecated since version 1.3.0.

Returns:

catCategorical or None

Categorical with removed categories or None if inplace=True.

Raises:

ValueError

If the removals are not contained in the categories

See also

rename_categories

Rename categories.

reorder_categories

Reorder categories.

add_categories

Add new categories.

remove_unused_categories

Remove categories which are not used.

set_categories

Set the categories to the specified ones.

Examples

>>> c = pd.Categorical(['a', 'c', 'b', 'c', 'd'])
>>> c
['a', 'c', 'b', 'c', 'd']
Categories (4, object): ['a', 'b', 'c', 'd']

>>> c.remove_categories(['d', 'a'])
[NaN, 'c', 'b', 'c', NaN]
Categories (2, object): ['b', 'c']

previous

pandas.CategoricalIndex.add_categories

next

pandas.CategoricalIndex.remove_unused_categories