Skip to contents

Generic function to abbreviate string to first n words with case formatting

Source: R/fct_generate_IDs.R
abbreviate_string.Rd

Takes a string, extracts the first n words (removing special characters), and formats them according to the specified case style.

Usage

abbreviate_string(
  string,
  n_words,
  case = c("lower", "upper", "sentence", "snake", "title", "screamingsnake", "camel")
)

Arguments

string

Character. The input string to abbreviate.

n_words

Integer. Number of words to include in the abbreviation.

case

Character. Case style for the output. One of:

  • "lower" — all lowercase, no separator (e.g., "dogsandcats")

  • "upper" — all uppercase, no separator (e.g., "DOGSANDCATS")

  • "sentence" — sentence case, no separator (e.g., "Dogsandcats")

  • "snake" — lowercase with underscores (e.g., "dogs_and_cats")

  • "title" — title case, no separator (e.g., "DogsAndCats")

  • "screamingsnake" — uppercase with underscores (e.g., "DOGS_AND_CATS")

  • "camel" — camel case (e.g., "dogsAndCats")

Value

Character. The abbreviated and formatted string.

See also

Other generate_id: generate_protocol_id(), generate_reference_id(), generate_sample_id_with_components(), protocol_id_regex(), sample_id_regex()

Examples

abbreviate_string("Total Phosphorus Concentration", n_words = 2L, "snake")
#> [1] "total_phosphorus"
abbreviate_string("dogs and cats", n_words = 3L, "title")
#> [1] "DogsAndCats"
abbreviate_string("Water Quality Index", n_words = 3L, "camel")
#> [1] "waterQualityIndex"