R: Units Attribute of a Vector

units {Hmisc} | R Documentation

## Units Attribute of a Vector

### Description

Sets or retrieves the `"units"` attribute of an object. For `units.default` replaces the builtin version, which only works for time series objects. If the variable is also given a `label`, subsetting (using `[.labelled`) will retain the `"units"` attribute. For a `Surv` object, `units` first looks for an overall `"units"` attribute, then it looks for `units` for the `time2` variable then for `time1`.

### Usage

    units(x, ...)
    ## Default S3 method:
    units(x, none='', ...)
    ## S3 method for class 'Surv'
    units(x, none='', ...)
    ## Default S3 replacement method:
    units(x) <- value

### Arguments

`x` | any object
`...` | ignored
`value` | the units of the object, or ""
`none` | value to which to set result if no appropriate attribute is found

### Value

the units attribute of x, if any; otherwise, the `units` attribute of the `tspar` attribute of `x` if any; otherwise the value `none`. Handling for `Surv` objects is different (see above).

### See Also

`label`

### Examples

    fail.time <- c(10,20)
    units(fail.time) <- "Day"
    describe(fail.time)
    S <- Surv(fail.time)
    units(S)

    label(fail.time) <- 'Failure Time'
    fail.time

[Package Hmisc version 4.7-0 Index]