Universe Alias#

Constructor#

Initialize a new UniverseAlias instance.

Constructor of the UniverseAlias class#

Argument

Type

Description

Required

Default

container

Container

A reference to the Container object that the symbol is being added to

Yes

name

string

Name of symbol

Yes

Fields#

Fields of the UniverseAlias class#

Field

Description

Type

aliasWith

always "*"

string

description

always Aliased with *

string

dimension

always 1

integer

domainLabels

always "uni"

character vector

domainNames

always "*"

character vector

domainType

always none

string

isSingleton

always FALSE

logical

name

name of symbol

string

numberRecords

number of symbol records (i.e., returns nrow(self$records) if not NULL)

integer

records

the main symbol records

data frame

container

reference to the Container that the symbol belongs to

Container

summary

output a list of only the metadata

list

Methods#

Methods of the UniverseAlias class#

Method

Description

Arguments/Defaults

Returns

equals

Check if two Symbol objects are equal

other (Symbol), checkMetaData=TRUE, verbose=FALSE

logical

copy

copies the symbol to the destination container. overwrite=TRUE overwrites the symbol with the same name in destination.

destination (Container), overwrite=FALSE

NULL

getSparsity

always 0

numeric

getUELs

returns the UELs from the Container. Returns only UELs in the data if ignoreUnused=TRUE, otherwise returns all UELs

ignoreUnused=FALSE

character vector

isValid

checks if the symbol is in a valid format, throw exceptions if verbose=TRUE, recheck a symbol if force=TRUE

verbose=FALSE, force=FALSE

logical