[Xts-commits] r734 - in pkg/xts: . man

[noreply at r-forge.r-project.org]

Author: jryan
Date: 2012-10-10 23:31:58 +0200 (Wed, 10 Oct 2012)
New Revision: 734

Added:
   pkg/xts/man/as.environment.Rd
Modified:
   pkg/xts/DESCRIPTION
Log:
o  increased version to 0.8-8
o  added documentation for new as.environment.xts


Modified: pkg/xts/DESCRIPTION
===================================================================
--- pkg/xts/DESCRIPTION	2012-10-06 12:50:46 UTC (rev 733)
+++ pkg/xts/DESCRIPTION	2012-10-10 21:31:58 UTC (rev 734)
@@ -1,7 +1,7 @@
 Package: xts
 Type: Package
 Title: eXtensible Time Series
-Version: 0.8-7.1
+Version: 0.8-8
 Date: 2012-10-05
 Author: Jeffrey A. Ryan, Joshua M. Ulrich
 Depends: zoo (>= 1.7-2)

Added: pkg/xts/man/as.environment.Rd
===================================================================
--- pkg/xts/man/as.environment.Rd	                        (rev 0)
+++ pkg/xts/man/as.environment.Rd	2012-10-10 21:31:58 UTC (rev 734)
@@ -0,0 +1,36 @@
+\name{as.environment.xts}
+\alias{as.environment.xts}
+\title{ Coerce an \sQuote{xts} Object to an Environment by Column }
+\description{
+Method to automatically convert an \sQuote{xts} object to an environment
+containing vectors representing each column of the original xts object. Each
+objects will be named according to the column name it is exracted by.
+}
+\usage{
+\method{as.environment}{xts}(x)
+}
+\arguments{
+  \item{x}{ an \code{xts} object }
+}
+\details{
+An experimental tool to convert \code{xts} objects into environments
+for simplifying use withing the standard R formula/data paradigm.
+}
+\value{
+An \code{environment} containing \code{ncol(x)} vectors
+extracted by column from \code{x}.  Note that environments
+do not preserve (or have knowledge) of column position, a.k.a order.
+}
+\author{ Jeffrey A. Ryan }
+\examples{
+x <- xts(1:10, Sys.Date()+1:10)
+colnames(x) <- "X"
+y <- xts(1:10, Sys.Date()+1:10)
+colnames(x) <- "Y"
+xy <- cbind(x,y)
+colnames(xy)
+e <- as.environment(xy)    # currently using xts-style positive k 
+ls(xy)
+ls.str(xy)
+}
+\keyword{ manip }% __ONLY ONE__ keyword per line