camelCase: Camel case

Description Usage Arguments Details Value Note Examples

Description

Format character strings to use (lower) camel-style formatting, where word boundaries are defined by capitlization only (e.g. thisIsCamelCase).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
camelCase(object, ...)

## S4 method for signature 'atomic'
camelCase(object, names = TRUE, strict = FALSE)

## S4 method for signature 'factor'
camelCase(object, names = TRUE, strict = FALSE)

## S4 method for signature 'list'
camelCase(object, names = TRUE, strict = FALSE)

## S4 method for signature 'matrix'
camelCase(object, rownames = FALSE, colnames = TRUE, strict = FALSE)

## S4 method for signature 'data.frame'
camelCase(object, rownames = FALSE, colnames = TRUE, strict = FALSE)

## S4 method for signature 'Vector'
camelCase(object, names = TRUE, mcols = TRUE, metadata = TRUE, strict = FALSE)

## S4 method for signature 'DataFrame'
camelCase(
  object,
  rownames = FALSE,
  colnames = TRUE,
  mcols = TRUE,
  metadata = TRUE,
  strict = FALSE
)

## S4 method for signature 'Ranges'
camelCase(object, names = FALSE, mcols = TRUE, metadata = TRUE, strict = FALSE)

## S4 method for signature 'Matrix'
camelCase(object, rownames = FALSE, colnames = TRUE, strict = FALSE)

## S4 method for signature 'SummarizedExperiment'
camelCase(
  object,
  rownames = FALSE,
  colnames = TRUE,
  assayNames = TRUE,
  rowData = TRUE,
  colData = TRUE,
  metadata = TRUE,
  strict = FALSE
)

Arguments

object

Object.

names

logical(1). Sanitize names.

Only applies to string mode (rename = FALSE).

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.

rownames

logical(1). Apply sanitization on row names. This is not generally recommended by default, since rownames commonly contain gene identifiers that should not be modified.

colnames

logical(1). Apply to column names.

mcols

logical(1). Sanitize names of metadata columns (i.e. DataFrame).

metadata

logical(1). Sanitize metadata names.

assayNames

logical(1). Sanitize assay names.

rowData

logical(1). Sanitize the row data names.

colData

logical(1). Sanitize column names of column data.

...

Additional arguments.

Details

Camel case is recommended by Bioconductor for variable and function names.

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-05-11.

Examples

1
2
data(syntactic, package = "acidtest")
lapply(syntactic, camelCase)

acidgenomics/basejump documentation built on Aug. 15, 2020, 10:21 a.m.