atable (version 0.1.14)

get_alias: Get Aliases of column names

Description

Retrieves attributes label and units of class labelled and attribute alias otherwise.

Usage

get_alias(x, ...)
# S3 method for labelled
get_alias(x, ...)
# S3 method for default
get_alias(x, ...)
# S3 method for data.frame
get_alias(x, ...)
# S3 method for list
get_alias(x, ...)

Value

For atomic vectors a character of NULL; for non-atomic vectors the results of get_alias applied to its elements.

Arguments

x

An object. Aliases will be retrieved of x.

...

Passed from and to other methods.

Methods (by class)

• get_alias(labelled): Retrieve attributes label and units, if available. Units are bracketed by '[]'. See also label and units. The user may alter this method via atable_options, see help there.

• get_alias(default): Retrieve attribute alias via attr. This attribute may be an arbitrary character. If there is no attribute alias, then get_alias.default returns NULL.

• get_alias(data.frame): Calls get_alias on every column.

• get_alias(list): Calls get_alias on every element of the list.

Details

We use attributes here, to assign alternative names to columns. Also class labelled created by Hmisc's label is supported.

This is a workhorse function, see create_alias_mapping for the high level function