[Eventstudies-commits] r20 - pkg/man

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

Author: vikram
Date: 2011-09-19 10:58:32 +0200 (Mon, 19 Sep 2011)
New Revision: 20

Modified:
   pkg/man/eventstudy-package.Rd
   pkg/man/inference.change.boot.Rd
   pkg/man/inr.Rd
   pkg/man/phys2eventtime.Rd
   pkg/man/remap.cumsum.Rd
   pkg/man/remap.event.reindex.Rd
Log:
Updated eventstudies documentation

Modified: pkg/man/eventstudy-package.Rd
===================================================================
--- pkg/man/eventstudy-package.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/eventstudy-package.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -5,7 +5,7 @@
 Event study analysis.
 }
 \description{
-The is a package to do Event Studies using R.
+This package is used to do Event Studies using R.
 }
 \details{
 \tabular{ll}{

Modified: pkg/man/inference.change.boot.Rd
===================================================================
--- pkg/man/inference.change.boot.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/inference.change.boot.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -6,10 +6,7 @@
 }
 \description{
 z.e is a zoo object, where rows are in event time
-and columns are units of observation.
-Sampling with replacement is done within the units of
-observation. Each time, the Ecar(t1) and Ecar(t2) is
-computed.
+and columns are units of observation. Sampling with replacement is done within the units of observation. Each time, the Ecar(t1) and Ecar(t2) is computed.
 By default, the statistic of interest is the ratio
 Ecar(t2)/Ecar(t1)
 But if operator="difference" is sent in, then the

Modified: pkg/man/inr.Rd
===================================================================
--- pkg/man/inr.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/inr.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -5,12 +5,10 @@
 INR/USD
 }
 \description{
-A sample of INR/USD rates from 1990 to 2011. It is stored as an xts object.  
+A sample of INR/USD rates from 1990 to 2011. It is stored as an xts object. 
 }
 \usage{data(inr)}
-\format{
-  The format is:
- chr "inr.rda"
+\format{ It is an xts object containing daily data from 1990 to 2011.  The format is: chr "inr.rda"
 }
 \examples{
 data(inr)

Modified: pkg/man/phys2eventtime.Rd
===================================================================
--- pkg/man/phys2eventtime.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/phys2eventtime.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -11,11 +11,8 @@
 }
 \arguments{
   \item{z}{
-z is a zoo object containing input data. E.g. this could be all the 
-prices of a bunch of stocks. The column name is the unit name.
-events is a data.frame containing 2 columns. The first column
-("unit") is the name of the unit. The second column is the date/time
-("when") when the event happened.
+z is a zoo object containing input data. E.g. this could be all the prices of a bunch of stocks. The column name is the unit name.
+events is a data.frame containing 2 columns. The first column ("unit") is the name of the unit. The second column is the date/time ("when") when the event happened.
 }
   \item{events}{
 A data.frame containing unit name and corresponding event dates.

Modified: pkg/man/remap.cumsum.Rd
===================================================================
--- pkg/man/remap.cumsum.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/remap.cumsum.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -5,16 +5,11 @@
 }
 \description{
 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.
 }
@@ -22,19 +17,19 @@
 is.pc is a logical flag to indicate that the values are in percentage form.
 }
   \item{base}{
-base (default 0) for the cumulative sum.
-
+base for the cumulative sum (default: base = 0).
 }
 }
 \value{
 The frame returned has each column replaced by the cumulative sum of the column.
-
 }
-
+\seealso{
+phys2eventtime
+}
 \examples{
 ##---- Should be DIRECTLY executable !! ----
 ##-- ==>  Define data, use random,
-##--	or do  help(data=index)  for the standard data sets.
+##--	or do  help(data=index) for the standard data sets.
 
 ## The function is currently defined as
 function (z, is.pc = TRUE, base = 0) 

Modified: pkg/man/remap.event.reindex.Rd
===================================================================
--- pkg/man/remap.event.reindex.Rd	2011-09-14 09:15:06 UTC (rev 19)
+++ pkg/man/remap.event.reindex.Rd	2011-09-19 08:58:32 UTC (rev 20)
@@ -5,12 +5,8 @@
 }
 \description{
 
-A function which consumes a zoo object where there are lots of events
-(as columns)
-The contents are all levels
-For each column, the event date value is set to 100 and all other
-values are scaled accordingly.
-
+A function which consumes a zoo object where there are lots of events (as columns). The contents are all levels.
+For each column, the event date value is set to 100 and all other values are scaled accordingly.
 It's input is a zoo object which is the first component of the list returned by phys2eventtime.
 
 }
@@ -18,7 +14,7 @@
 remap.event.reindex(z)
 }
 \arguments{
-  \item{z}{
+  \item{z}{ z is a zoo object containing input data from phys2eventtime.
 }
 }
 \value{