crunch (version 1.25.0)

names,BatchCatalog-method: Get and set names, aliases on Catalog-type objects

Description

These methods let you get and set names and aliases for variables in a Dataset's catalog, or within Subvariables in an array variable. They work like the base R names methods.

Usage

# S4 method for BatchCatalog
names(x)
# S4 method for CrunchDataset
names(x)
# S4 method for MultitableCatalog
names(x) <- value
# S4 method for ShojiCatalog
names(x)
# S4 method for ShojiCatalog
names(x) <- value
# S4 method for ShojiCatalog
emails(x)
# S4 method for ShojiFolder
types(x)
# S4 method for CategoricalArrayVariable
names(x)
# S4 method for VariableCatalog
aliases(x)
# S4 method for VariableCatalog
aliases(x) <- value
# S4 method for VariableCatalog
notes(x)
# S4 method for VariableCatalog
notes(x) <- value
# S4 method for VariableCatalog
descriptions(x)
# S4 method for VariableCatalog
descriptions(x) <- value
# S4 method for VariableCatalog
types(x)
# S4 method for VariableCatalog
ids(x)
# S4 method for VariableFolder
aliases(x)
# S4 method for VersionCatalog
names(x)
# S4 method for VersionCatalog
descriptions(x)
# S4 method for VersionCatalog
timestamps(x)

Arguments

x

a VariableCatalog, Subvariables, or similar object

value

For the setters, an appropriate-length character vector to assign

Value

Getters return the character object in the specified slot; setters return x duly modified.

Details

Note that the Dataset names method returns the aliases of its variables by default. This behavior is controlled by getOption("crunch.namekey.dataset"). Set options(crunch.namekey.dataset="name") if you wish to use variable names. See the variables vignette for more information.

See Also

Subvariables Categories base::names() vignette("variables", package="crunch")