xtsAttributes

From xts v0.9-7 by Jeffrey Ryan

Extract and Replace xts Attributes

Extract and replace non-core xts attributes.

Keywords: utilities

Usage

xtsAttributes(x, user=NULL)
xtsAttributes(x) <- value

Arguments

x: an xts object
user: logical; should user-defined attributes be returned? The default of NULL returns all xts attributes.
value: a list of new name=value attributes

Details

Since xts objects are S3 objects with special attributes, a method is necessary to properly assign and view the user-added attributes.

A call to attributes from the base package will return all attributes, including those specific to the xts class.

Value

A named list of user settable attributes.

Examples

library(xts)

# NOT RUN {
x <- xts(matrix(1:(9*6),nc=6),
         order.by=as.Date(13000,origin="1970-01-01")+1:9,
         a1='my attribute')

xtsAttributes(x)
xtsAttributes(x) <- list(a2=2020)

xtsAttributes(x)
xtsAttributes(x) <- list(a1=NULL)
xtsAttributes(x)
# }

Documentation reproduced from package xts, version 0.9-7, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.