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 class 'AbstractCategories'
names(x)

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

# S4 method for class 'AbstractCategories'
ids(x)

# S4 method for class 'ScriptCatalog'
timestamps(x)

# S4 method for class 'Script'
timestamps(x)

# S4 method for class 'Script'
scriptBody(x)

# S4 method for class 'BatchCatalog'
names(x)

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

# S4 method for class 'Categories'
values(x)

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

# S4 method for class 'Categories'
dates(x)

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

# S3 method for class 'CrunchDataFrame'
names(x)

# S4 method for class 'CrunchCube'
names(x)

# S4 method for class 'CrunchCube'
aliases(x)

# S4 method for class 'CrunchCube'
descriptions(x)

# S4 method for class 'CrunchCube'
types(x)

# S4 method for class 'CrunchCube'
notes(x)

# S4 method for class 'CrunchDataset'
names(x)

# S4 method for class 'ShojiCatalog'
names(x)

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

# S4 method for class 'ShojiCatalog'
emails(x)

# S4 method for class 'CrunchDeck'
names(x)

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

# S4 method for class 'CrunchDeck'
types(x)

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

# S4 method for class 'ShojiFolder'
types(x)

# S4 method for class 'ShojiOrder'
names(x)

# S4 method for class 'OrderGroup'
names(x)

# S4 method for class 'SlideCatalog'
names(x)

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

# S4 method for class 'SlideCatalog'
types(x)

# S4 method for class 'ArrayVariable'
names(x)

# S4 method for class 'TabBookResult'
names(x)

# S4 method for class 'TabBookResult'
aliases(x)

# S4 method for class 'TabBookResult'
descriptions(x)

# S4 method for class 'MultitableResult'
names(x)

# S4 method for class 'MultitableResult'
aliases(x)

# S4 method for class 'MultitableResult'
descriptions(x)

# S4 method for class 'VariableCatalog'
aliases(x)

# S4 method for class 'VariableCatalog'
aliases(x) <- value

# S4 method for class 'VariableCatalog'
notes(x)

# S4 method for class 'VariableCatalog'
notes(x) <- value

# S4 method for class 'VariableCatalog'
descriptions(x)

# S4 method for class 'VariableCatalog'
descriptions(x) <- value

# S4 method for class 'VariableCatalog'
types(x)

# S4 method for class 'VariableCatalog'
ids(x)

# S4 method for class 'VariableFolder'
aliases(x)

# S4 method for class 'list'
types(x)

# S4 method for class 'VersionCatalog'
names(x)

# S4 method for class 'VersionCatalog'
descriptions(x)

# S4 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 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.