Get and set names, aliases on Catalog-type objects

Source: R/AllGenerics.R, R/abstract-categories.R, R/automation.R, and 17 more

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.

aliases(x)

aliases(x) <- value

descriptions(x)

descriptions(x) <- value

emails(x)

types(x)

timestamps(x)

ids(x)

ids(x) <- value

values(x)

values(x) <- value

scriptBody(x)

dates(x)

dates(x) <- value

# S4 method for AbstractCategories
names(x)

# S4 method for AbstractCategories
names(x) <- value

# S4 method for AbstractCategories
ids(x)

# S4 method for ScriptCatalog
timestamps(x)

# S4 method for Script
timestamps(x)

# S4 method for Script
scriptBody(x)

# S4 method for BatchCatalog
names(x)

# S4 method for Categories
ids(x) <- value

# S4 method for Categories
values(x)

# S4 method for Categories
values(x) <- value

# S4 method for Categories
dates(x)

# S4 method for Categories
dates(x) <- value

# S3 method for CrunchDataFrame
names(x)

# S4 method for CrunchCube
names(x)

# S4 method for CrunchCube
aliases(x)

# S4 method for CrunchCube
descriptions(x)

# S4 method for CrunchCube
types(x)

# S4 method for CrunchCube
notes(x)

# S4 method for CrunchDataset
names(x)

# S4 method for ShojiCatalog
names(x)

# S4 method for ShojiCatalog
names(x) <- value

# S4 method for ShojiCatalog
emails(x)

# S4 method for CrunchDeck
names(x)

# S4 method for CrunchDeck
names(x) <- value

# S4 method for CrunchDeck
types(x)

# S4 method for MultitableCatalog
names(x) <- value

# S4 method for ShojiFolder
types(x)

# S4 method for ShojiOrder
names(x)

# S4 method for OrderGroup
names(x)

# S4 method for SlideCatalog
names(x)

# S4 method for SlideCatalog
names(x) <- value

# S4 method for SlideCatalog
types(x)

# S4 method for ArrayVariable
names(x)

# S4 method for TabBookResult
names(x)

# S4 method for TabBookResult
aliases(x)

# S4 method for TabBookResult
descriptions(x)

# S4 method for MultitableResult
names(x)

# S4 method for MultitableResult
aliases(x)

# S4 method for MultitableResult
descriptions(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 list
types(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 envOrOption("crunch.namekey.dataset"). Set options(crunch.namekey.dataset="name") if you wish to use variable names. See the variables vignette for more information.