fctutils (version 0.0.7)

ft_split: Split Factor Levels and Reorder Based on Specified Criteria

Description

Splits the levels of a factor vector using specified patterns or positions and reorders based on specified parts or criteria. Optionally reorders the data vector's elements to align with the new levels' order.

Usage

ft_split(
  factor_vec,
  split_pattern,
  use_pattern = NULL,
  part = 1,
  position = NULL,
  char_freq = FALSE,
  decreasing = FALSE,
  inplace = FALSE
)

Value

A factor vector with levels reordered based on the specified conditions. Depending on the inplace parameter, the data vector's elements may also be reordered.

Arguments

factor_vec

A factor vector to be processed.

split_pattern

A character vector specifying the pattern(s) or position(s) to use for splitting. Can be regular expressions or integer positions.

use_pattern

An integer specifying which pattern to use if multiple patterns are provided. Default is NULL by using all patterns.

part

An integer or integer vector specifying which part(s) to use after splitting (e.g., 1 for the first part). Can be a range or specific indices.

position

An integer or integer vector specifying the character positions within the part(s) to consider.

char_freq

Logical. Should the sorting be based on character frequencies within the specified part(s)? Default is FALSE.

decreasing

Logical. Should the ordering be decreasing? Default is FALSE.

inplace

Logical. If TRUE, returns a new factor vector with elements reordered to align with the new levels' order. If FALSE, returns a new factor vector with only the levels' order adjusted, leaving the data vector's elements' order unchanged. Defaults to FALSE.

Author

Kai Guo

Examples

# Example 1: Split by patterns '-', '_', or '|' and reorder based on the
# first part without reordering data elements
factor_vec <- factor(c('item1-sub1', 'item2_sub2', 'item3|sub3', 'item1-sub4'))
ft_split(factor_vec, split_pattern = c('-', '_', '\\|'), part = 1, inplace = FALSE)

# Example 2: Use the second pattern '_' for splitting and reorder
# data elements
ft_split(factor_vec, split_pattern = c('-', '_', '\\|'), use_pattern = 2, part = 2, inplace = TRUE)

# Example 3: Reorder based on character frequencies in the specified part
# without reordering data elements
ft_split(factor_vec, split_pattern = '-', part = 2, char_freq = TRUE, inplace = FALSE)

# Example 4: Split by pattern '-' and reorder both levels and data
# elements based on the first part
ft_split(factor_vec, split_pattern = '-', part = 1, inplace = TRUE)