ft_reverse: Reverse Factor Levels

View source: R/fct_misc.R

ft_reverseR Documentation

Reverse Factor Levels

Description

Reverses the order of the levels in a factor vector. Optionally reorders the data vector's elements to align with the reversed levels' order.

Usage

ft_reverse(factor_vec, inplace = FALSE)

Arguments

factor_vec

A factor vector whose levels will be reversed.

inplace

Logical. If TRUE, returns a new factor vector with elements reordered to align with the reversed levels' order. If FALSE, returns a new factor vector with levels reversed without changing the data vector's elements' order. Defaults to FALSE.

Value

A factor vector with levels in reversed order. Depending on the inplace parameter, the data vector's elements may also be reordered.

Author(s)

Kai Guo

Examples

# Example factor vector
factor_vec <- factor(c('low', 'medium', 'high'))

# Reverse the levels without reordering data elements
reversed_factor <- ft_reverse(factor_vec)
print(reversed_factor)
# [1] low    medium high
# Levels: high medium low

# Reverse the levels and reorder data elements
reversed_factor_inplace <- ft_reverse(factor_vec, inplace = TRUE)
print(reversed_factor_inplace)
# [1] high   medium low
# Levels: high medium low

fctutils documentation built on Oct. 1, 2024, 1:07 a.m.