[Eventstudies-commits] r56 - pkg/man

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

Author: vikram
Date: 2013-04-08 20:55:30 +0200 (Mon, 08 Apr 2013)
New Revision: 56

Modified:
   pkg/man/eventstudy-package.Rd
   pkg/man/inference.Ecar.Rd
   pkg/man/phys2eventtime.Rd
   pkg/man/remap.cumprod.Rd
   pkg/man/remap.event.reindex.Rd
Log:
Minor modifications in documentation

Modified: pkg/man/eventstudy-package.Rd
===================================================================
--- pkg/man/eventstudy-package.Rd	2013-04-08 12:04:38 UTC (rev 55)
+++ pkg/man/eventstudy-package.Rd	2013-04-08 18:55:30 UTC (rev 56)
@@ -7,7 +7,7 @@
 }
 
 \description{
-This package is used to undertake event study analyses using R.
+This package is used to undertake event study analysis using R.
 }
 
 \details{

Modified: pkg/man/inference.Ecar.Rd
===================================================================
--- pkg/man/inference.Ecar.Rd	2013-04-08 12:04:38 UTC (rev 55)
+++ pkg/man/inference.Ecar.Rd	2013-04-08 18:55:30 UTC (rev 56)
@@ -6,7 +6,7 @@
 }
 
 \description{
-This function does bootstrap inference for the entire Ecar, i.e. main graph of the event study.
+This function does bootstrap inference to generate distribution of average of all the cumulative returns time-series.
  }
 
 \usage{
@@ -19,7 +19,7 @@
 }
 
 \value{
-A data frame with 3 columns,the lower CI,the mean and the upper CI which are the result of bootstrap inference.
+A data frame with 3 columns, the lower confidence interval (CI), the mean and the upper CI which are the result of bootstrap inference.
 }
 
 \seealso{

Modified: pkg/man/phys2eventtime.Rd
===================================================================
--- pkg/man/phys2eventtime.Rd	2013-04-08 12:04:38 UTC (rev 55)
+++ pkg/man/phys2eventtime.Rd	2013-04-08 18:55:30 UTC (rev 56)
@@ -14,16 +14,16 @@
 }
 
 \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.}
+  \item{z}{Time series data for which event frame is to be generated.}
 
-  \item{events}{A data.frame containing unit name and corresponding event dates.}
+  \item{events}{It is a data frame with two columns: unit and when. unit has column name of which response is to measured on the event date, while when has the event date.}
 
-  \item{width}{Width corresponds to the number of days on each side of the event date.}
+  \item{width}{Width corresponds to the number of days on each side of the event date.For a given width, if there is any NA in the event window then the last observation is carried forward.}
 
 }
 
-\value{Returns a list containing 1. A zoo object indexed with event time, and having "enough data points" and 2. a vector which describes the status of each unit in the original data ( this maybe more than the no of units in 1 ).}
+\value{Output is in a list format. A zoo object indexed with event time and a vector which describes the status of each unit in the original data.
+}
 
 
 \examples{

Modified: pkg/man/remap.cumprod.Rd
===================================================================
--- pkg/man/remap.cumprod.Rd	2013-04-08 12:04:38 UTC (rev 55)
+++ pkg/man/remap.cumprod.Rd	2013-04-08 18:55:30 UTC (rev 56)
@@ -10,7 +10,7 @@
 \arguments{
   \item{z}{z is the zoo object returned from phys2eventtime.}
 
-  \item{is.pc}{Logical flag if input is a percentage}
+  \item{is.pc}{Logical flag if input is a percentage.}
 
   \item{is.returns}{Logical flag if input is returns.}
 

Modified: pkg/man/remap.event.reindex.Rd
===================================================================
--- pkg/man/remap.event.reindex.Rd	2013-04-08 12:04:38 UTC (rev 55)
+++ pkg/man/remap.event.reindex.Rd	2013-04-08 18:55:30 UTC (rev 56)
@@ -11,7 +11,7 @@
 \usage{remap.event.reindex(z)}
 
 \arguments{  
-    \item{z}{ z is a zoo object containing input data from phys2eventtime.}
+    \item{z}{z is a zoo object containing input data from phys2eventtime.}
 }
 
 \value{The function returns a zoo object which has been rescaled.}