pyspark.pandas.CategoricalIndex.remove_categories¶

CategoricalIndex.remove_categories(removals: Union[pandas.core.indexes.base.Index, Any, List], inplace: bool = False) → Optional[pyspark.pandas.indexes.category.CategoricalIndex][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.
inplacebool, default False: Whether or not to remove the categories inplace or return a copy of this categorical with removed categories.

Deprecated since version 3.2.0.

Returns

CategoricalIndex 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

>>> 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')

pyspark.pandas.CategoricalIndex.add_categories pyspark.pandas.CategoricalIndex.remove_unused_categories