Format character strings to use snake-style formatting, where word boundaries
are defined by underscores (e.g. this_is_snake_case).
Usage
snakeCase(object, ...)
# S4 method for character
snakeCase(object, smart = TRUE, names = TRUE, prefix = TRUE)Arguments
- object
Object.
- smart
logical(1). Handle complicated special cases, such as mixed case acronyms, plus/minus, percentages, etc.- names
logical(1). Sanitize names.Only applies to string mode (
rename = FALSE).- prefix
logical(1). Prepend "X" character if necessary, when string begins with a syntactically invalid character, such as a number or non-alphanumeric. Note that names are always made syntactically valid when applicable with "X" prefix. Seemake.names()for details.Enabled by default for string mode, but disabled by default for rename mode, when applicable.
- ...
Additional arguments.
Value
Modified object.
Contains syntatically valid names.
For objects with names() defined, the underlying data
returns unchanged, except for character or vector class.
Examples
data(syntactic, package = "AcidTest")
object <- syntactic$character
snakeCase(object)
#> [1] "percent_gc" "x10um" "x5_3_bias"
#> [4] "x5prime" "g2m_score" "hello_world"
#> [7] "hello_world" "mazda_rx4" "n_count"
#> [10] "rnai_clones" "tx2gene" "tx2_gene_id"
#> [13] "worfdb_html_remap" "x123"