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

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

Author: rossbennett34
Date: 2015-01-10 15:55:05 +0100 (Sat, 10 Jan 2015)
New Revision: 868

Added:
   pkg/xts/man/addEventLines.Rd
Removed:
   pkg/xts/man/addLines.Rd
Modified:
   pkg/xts/NAMESPACE
   pkg/xts/R/plot.R
Log:
rename addLines to addEventLines to avoid confusion with lines and addSeries

Modified: pkg/xts/NAMESPACE
===================================================================
--- pkg/xts/NAMESPACE	2014-12-30 03:36:30 UTC (rev 867)
+++ pkg/xts/NAMESPACE	2015-01-10 14:55:05 UTC (rev 868)
@@ -121,7 +121,7 @@
 
 export(plot.xts)
 export(addLegend)
-export(addLines)
+export(addEventLines)
 export(addPoints)
 export(addSeries)
 S3method(plot,xts)

Modified: pkg/xts/R/plot.R
===================================================================
--- pkg/xts/R/plot.R	2014-12-30 03:36:30 UTC (rev 867)
+++ pkg/xts/R/plot.R	2015-01-10 14:55:05 UTC (rev 868)
@@ -896,7 +896,7 @@
 #' @param col color palette to use, set by default to rational choices.
 #' @param \dots any other passthrough parameters. Not currently used.
 #' @author Ross Bennett
-addLines <- function(event.dates, event.labels=NULL, date.format="%Y-%m-%d", main="", on=NA, lty=1, lwd=1, col=1, ...){
+addEventLines <- function(event.dates, event.labels=NULL, date.format="%Y-%m-%d", main="", on=NA, lty=1, lwd=1, col=1, ...){
   # add checks for event.dates and event.labels
   if(!is.null(event.labels))
     if(length(event.dates) != length(event.labels)) stop("length of event.dates must match length of event.labels")

Added: pkg/xts/man/addEventLines.Rd
===================================================================
--- pkg/xts/man/addEventLines.Rd	                        (rev 0)
+++ pkg/xts/man/addEventLines.Rd	2015-01-10 14:55:05 UTC (rev 868)
@@ -0,0 +1,40 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
+\name{addEventLines}
+\alias{addEventLines}
+\title{Add vertical lines to an existing xts plot}
+\usage{
+addEventLines(event.dates, event.labels = NULL, date.format = "\%Y-\%m-\%d",
+  main = "", on = NA, lty = 1, lwd = 1, col = 1, ...)
+}
+\arguments{
+\item{event.dates}{character vector of dates. Vertical lines will be drawn
+to indicate that an event happened during that time period.  \code{event.lines} should
+be a vector of dates (e.g., \code{c("09/03","05/06"))} formatted the same as
+\code{date.format}. This function matches the re-formatted row names (dates) with
+the events.list, so to get a match the formatting needs to be correct.}
+
+\item{event.labels}{character vector of event labels corresponding to
+\code{event.dates}. This will apply text labels (e.g.,
+\code{c("This Event", "That Event")} to the vertical lines drawn.}
+
+\item{date.format}{format for the dates in \code{event.lines}.}
+
+\item{main}{main title for a new panel if drawn.}
+
+\item{on}{panel number to draw on. A new panel will be drawn if \code{on=NA}.}
+
+\item{lty}{set the line type, same as in \code{\link{plot}}.}
+
+\item{lwd}{set the line width, same as in \code{\link{plot}}.}
+
+\item{col}{color palette to use, set by default to rational choices.}
+
+\item{\dots}{any other passthrough parameters. Not currently used.}
+}
+\description{
+Add vertical lines to an existing xts plot
+}
+\author{
+Ross Bennett
+}
+

Deleted: pkg/xts/man/addLines.Rd
===================================================================
--- pkg/xts/man/addLines.Rd	2014-12-30 03:36:30 UTC (rev 867)
+++ pkg/xts/man/addLines.Rd	2015-01-10 14:55:05 UTC (rev 868)
@@ -1,40 +0,0 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
-\name{addLines}
-\alias{addLines}
-\title{Add vertical lines to an existing xts plot}
-\usage{
-addLines(event.dates, event.labels = NULL, date.format = "\%Y-\%m-\%d",
-  main = "", on = NA, lty = 1, lwd = 1, col = 1, ...)
-}
-\arguments{
-\item{event.dates}{character vector of dates. Vertical lines will be drawn
-to indicate that an event happened during that time period.  \code{event.lines} should
-be a vector of dates (e.g., \code{c("09/03","05/06"))} formatted the same as
-\code{date.format}. This function matches the re-formatted row names (dates) with
-the events.list, so to get a match the formatting needs to be correct.}
-
-\item{event.labels}{character vector of event labels corresponding to
-\code{event.dates}. This will apply text labels (e.g.,
-\code{c("This Event", "That Event")} to the vertical lines drawn.}
-
-\item{date.format}{format for the dates in \code{event.lines}.}
-
-\item{main}{main title for a new panel if drawn.}
-
-\item{on}{panel number to draw on. A new panel will be drawn if \code{on=NA}.}
-
-\item{lty}{set the line type, same as in \code{\link{plot}}.}
-
-\item{lwd}{set the line width, same as in \code{\link{plot}}.}
-
-\item{col}{color palette to use, set by default to rational choices.}
-
-\item{\dots}{any other passthrough parameters. Not currently used.}
-}
-\description{
-Add vertical lines to an existing xts plot
-}
-\author{
-Ross Bennett
-}
-