params: Parameters

In acidgenomics/r-syntactic: Syntactically Valid Names

Parameters

Description

Parameters

Arguments

names	logical(1). Sanitize names. Only applies to string mode (rename = FALSE).
object	Object.
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.
recursive	logical(1). Should the function recurse into directories? Only applicable when rename = TRUE.
rename	logical(1). File rename mode. Requires that input contains files and/or directories that exist on disk. Both case-sensitive (e.g. Linux) and -insensitive (e.g. macOS, Winddows) file systems are supported. The prefix and smart arguments are supported in this mode.
smart	logical(1). Handle complicated special cases, such as mixed case acronyms, plus/minus, percentages, etc.
strict	logical(1). Enforce strict name sanitization. When TRUE, this does not allow the return of any capitalized acronyms. "RNA" will become "Rna", for example.
unique	logical(1). If TRUE, the resulting elements are unique. Recommended by default, for syntactically valid names (e.g. column, row names). Note that this is disabled by default for make.names().
...	Additional arguments.

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