dottedCase: Dotted case

Description Usage Arguments Value Note Examples

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

 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
dottedCase(object, ...)

## S4 method for signature 'atomic'
dottedCase(object, names = TRUE)

## S4 method for signature 'factor'
dottedCase(object, names = TRUE)

## S4 method for signature 'list'
dottedCase(object, names = TRUE)

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

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

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

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

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

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

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

Arguments

object

Object.

names

logical(1). Sanitize names.

Only applies to string mode (rename = FALSE).

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.

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, dottedCase)

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