SASxport (version 1.3.4)

label: Set or Retreive the 'label', 'SASformat', 'SASiformat', or 'SAStype' attribute of a vector or (components of) a data frame

Description

Sets or retrieves the "label", "SASformat", "SASiformat", or SAStype attribute of an object.

More comprehensive support for object labels, and SASformat, are available in Frank Harrell's Hmisc package.

Note that SAStype enforces the SAS 8-character naming convention.

Usage

label(x, default)
label(x) <- value
SASformat(x, default)
SASformat(x) <- value
SASiformat(x, default)
SASiformat(x) <- value
SAStype(x, default)
SAStype(x) <- value

Arguments

x

any object

value

new value for the "label", "SASformat", "SASiformat", or SAStype attribute of an object.

default

value to return when no appropriate attribute is found. The usual return value is NULL.

Value

• the contents of the "label", "SASformat", "SASiformat", "SAStype" attribute of x, if any; otherwise, the value provided by default.

Examples

## Examples for vectors

fail.time <- c(10,20)

# set attributes
label(fail.time) <- 'Failure Time'
SASformat(fail.time) <- 'Numeric2'
SASiformat(fail.time) <- 'Numeric2'

# display individual attributes
label(fail.time)
SASformat(fail.time)
SASiformat(fail.time)

# display all attributes
attributes(fail.time)

## SAStype only applies to data frames
df <- data.frame( fail.time, day=c("Mon","Tue") )
label(df)   <- "Data frame object"
SAStype(df) <- "USER"

label(df)
SAStype(df)

## Example showing specification of default return value
a <- 70
label(a, default="no label")

# Hmisc packages functions label attributes for annotating tables and plots:
library(Hmisc)
label(fail.time)
describe(fail.time)