xtsAttributes: Extract and Replace xts Attributes

Description Usage Arguments Details Value Author(s) See Also Examples

Description

Extract and replace non-core xts attributes.

Usage

1
2
3
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.

Author(s)

Jeffrey A. Ryan

See Also

attributes

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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)


xts documentation built on May 19, 2017, 9:52 a.m.
Search within the xts package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.