Learn R Programming
crunch (version 1.9.4)

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

## S3 method for class 'BatchCatalog':
names(x)
## S3 method for class 'CrunchDataset':
names(x)
## S3 method for class 'ShojiCatalog':
emails(x)
## S3 method for class 'PermissionCatalog':
emails(x)
## S3 method for class 'ShojiCatalog':
names(x)
## S3 method for class 'ShojiCatalog':
names(x) <- value
## S3 method for class 'Subvariables':
aliases(x)
## S3 method for class 'Subvariables':
aliases(x) <- value
## S3 method for class 'CategoricalArrayVariable':
names(x)
## S3 method for class 'UserCatalog':
emails(x)
## S3 method for class 'VariableCatalog':
aliases(x)
## S3 method for class 'VariableCatalog':
aliases(x) <- value
## S3 method for class 'VariableCatalog':
descriptions(x)
## S3 method for class 'VariableCatalog':
descriptions(x) <- value
## S3 method for class 'VariableCatalog':
types(x)
## S3 method for class 'VersionCatalog':
names(x)
## S3 method for class 'VersionCatalog':
descriptions(x)
## S3 method for class '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 names method on a Dataset returns the aliases of its variables by default. This is controlled by getOption("crunch.namekey.dataset"), which is "alias" by default. Set options(crunch.namekey.dataset="name") if you wish to use variable names. See the vignette on variables for more information.

See Also

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