kebabCase: Kebab case

In acidgenomics/r-syntactic: Syntactically Valid Names

Kebab case

Description

Format character strings to use kebab-style formatting, where word boundaries are defined by dashes/hyphens (e.g. this-is-kebab-case).

Usage

kebabCase(object, ...)

## S4 method for signature 'character'
kebabCase(object, smart = TRUE, prefix = TRUE)

Arguments

object	Object.
smart	logical(1). Handle complicated special cases, such as mixed case acronyms, plus/minus, percentages, etc.
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. See make.names() for details. Enabled by default for string mode, but disabled by default for rename mode, when applicable.
...	Additional arguments.

Details

Kebab case is recommended for URL slugs and file names. However, they should not be used for names in R, since dashes are not valid, and should be substituted with underscores or periods instead.

Value

Modified object.

Note

Updated 2020-08-24.

Examples

data(syntactic, package = "AcidTest")
object <- syntactic$character
kebabCase(object)

acidgenomics/r-syntactic documentation built on Oct. 30, 2023, 3:08 a.m.