pyspark.pandas.Series.cat.as_ordered¶
-
cat.as_ordered(inplace: bool = False) → Optional[ps.Series]¶ Set the Categorical to be ordered.
- Parameters
- inplacebool, default False
Whether or not to set the ordered attribute in-place or return a copy of this categorical with ordered set to True.
- Returns
- Series or None
Ordered Categorical or None if
inplace=True.
Examples
>>> s = ps.Series(list("abbccc"), dtype="category") >>> s 0 a 1 b 2 b 3 c 4 c 5 c dtype: category Categories (3, object): ['a', 'b', 'c']
>>> s.cat.as_ordered() 0 a 1 b 2 b 3 c 4 c 5 c dtype: category Categories (3, object): ['a' < 'b' < 'c']