pyspark.pandas.CategoricalIndex.remove_categories#

CategoricalIndex.remove_categories(removals)[source]#

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.

Returns:
CategoricalIndex

Categorical with removed categories

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

>>> idx = ps.CategoricalIndex(list("abbccc"))
>>> idx
CategoricalIndex(['a', 'b', 'b', 'c', 'c', 'c'],
                 categories=['a', 'b', 'c'], ordered=False, dtype='category')
>>> idx.remove_categories('b')
CategoricalIndex(['a', nan, nan, 'c', 'c', 'c'],
                 categories=['a', 'c'], ordered=False, dtype='category')