dottedCase: Dotted case

dottedCaseR Documentation

Dotted case

Description

Support is provided for matching against base R parameters. However, it is recommended to avoid using it for variable assignments into an environment, as that can introduce conflicts with base functions.

Usage

dottedCase(object, ...)

## S4 method for signature 'character'
dottedCase(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. See make.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.

Note

Updated 2020-01-27.

Examples

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

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