[Eventstudies-commits] r205 - pkg/man

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

Author: chiraganand
Date: 2014-03-18 22:16:23 +0100 (Tue, 18 Mar 2014)
New Revision: 205

Modified:
   pkg/man/remap.cumsum.Rd
Log:
Formatting changes.

Modified: pkg/man/remap.cumsum.Rd
===================================================================
--- pkg/man/remap.cumsum.Rd	2014-03-18 21:11:43 UTC (rev 204)
+++ pkg/man/remap.cumsum.Rd	2014-03-18 21:16:23 UTC (rev 205)
@@ -1,36 +1,40 @@
 \name{remap.cumsum}
 \alias{remap.cumsum}
-\title{
-This function gives the cumulative total of the values ( in level or percentage form ).
-}
+
+\title{This function gives the cumulative total of the values (in
+  level or percentage form).}
+
 \description{
-This function gives the cumulative total of the values. 
+  This function gives the cumulative total of the values. 
 }
+
 \usage{
 remap.cumsum(z, is.pc = TRUE, base = 0)
 }
+
 \arguments{
-  \item{z}{
-z is the zoo object returned from phys2eventtime.
+  \item{z}{a \pkg{zoo} object indexed by event time, as returned from
+    \dQuote{phys2eventtime}.}
+
+  \item{is.pc}{\sQuote{logical}, whether input is a percentage.}
+
+  \item{base}{an integer specifying the base for cumulative sum.}
 }
-  \item{is.pc}{
-is.pc is a logical flag to indicate that the values are in percentage form.
-}
-  \item{base}{
-base for the cumulative sum (default: base = 0).
-}
-}
-\value{
-The frame returned has each column replaced by the cumulative sum of the column.
-}
+
+\value{A \pkg{zoo} series is returned having each column replaced by
+  the cumulative sum of the column.}
+
 \seealso{
-eventDays, eventstudyData, phys2eventtime
+  eventDays, eventstudyData, phys2eventtime
 }
+
 \examples{
 data(StockPriceReturns)
 data(SplitDates)
-es.results <- phys2eventtime(z=StockPriceReturns, events=SplitDates,width=5)
-es.w <- window(es.results$z.e, start=-5, end=+5)
-eventtime <- remap.cumsum(es.w, is.pc=FALSE, base=0)
+
+es.results <- phys2eventtime(z = StockPriceReturns,
+                             events = SplitDates,
+                             width = 5)
+es.w <- window(es.results$z.e, start = -5, end = +5)
+eventtime <- remap.cumsum(es.w, is.pc = FALSE, base = 0)
 }
-