[Eventstudies-commits] r255 - pkg/man

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

Author: chiraganand
Date: 2014-03-28 17:33:01 +0100 (Fri, 28 Mar 2014)
New Revision: 255

Modified:
   pkg/man/eventstudy.Rd
Log:
Added description of arguments, added return value for unscuccessful outcomes, changed function description and title.

Modified: pkg/man/eventstudy.Rd
===================================================================
--- pkg/man/eventstudy.Rd	2014-03-28 15:25:14 UTC (rev 254)
+++ pkg/man/eventstudy.Rd	2014-03-28 16:33:01 UTC (rev 255)
@@ -1,12 +1,17 @@
 \name{eventstudy}
 \alias{eventstudy}
 
-\title{Event study analysis}
+\title{Function for performing event study analysis}
 
-\description{This function performs event study analysis and further computes confidence interval}
+\description{
+  %% FIXME
+  \sQuote{eventstudy} performs event study analysis. It calculates
+  returns using a specified model, converts physical dates to event
+  frame, and conducts inference on the unit of interest.
+}
 
 \usage{
-eventstudy(firm.returns = NULL,
+eventstudy(firm.returns,
            eventList,
            width = 10,
            is.levels =  FALSE,
@@ -20,23 +25,22 @@
 
 \arguments{
   \item{firm.returns}{
-    data on which event study is to be performed.
+   a \pkg{zoo} timeseries on which event study is to be performed.
   }
 
   \item{eventList}{
-    \sQuote{data.frame} of two columns containing event
-    dates. \dQuote{outcome.unit} consists of column names of the event
-    stock, and \dQuote{event.when} is the respective event date.
+    \sQuote{data.frame} of two columns containing event dates to pass to
+    \code{\link{phys2eventtime}} function. \dQuote{outcome.unit}
+    consists of column names of series inside \dQuote{firm.returns}, and
+    \dQuote{event.when} is the respective event date.
   }
 
-  \item{width}{integer of length 1, which creates an event window to
+  \item{width}{integer of length 1, creates an event window to
     study the impact (pre and post event) on the variable.}
 
   \item{type}{
     a scalar of type \sQuote{character} specifying the market
-    model adjustment. Currently supported options are:
-    \dQuote{marketResidual}, \dQuote{excessReturn}, \dQuote{lmAMM} and
-    \dQuote{None}. Defaults to \dQuote{marketResidual}. See \sQuote{Details}.
+    model adjustment. See \sQuote{Details}.
   }
 
   \item{to.remap}{\sQuote{logical}, indicating whether to convert
@@ -73,8 +77,39 @@
   }
 }
 
-\details{This function performs event study analysis using basic functions from the package. 
-The function needs firm returns as input and provides argument \sQuote{type} to generate abnormal returns, if required. If \sQuote{type} is \sQuote{market.residuals} then it will generate abnormal returns using a market model. It also provides option to estimate returns using augmented market model (AMM) which purges out market returns and \sQuote{others} i.e. currency in our case (\sQuote{type} as \sQuote{lmAMM}). The function computes confidence interval using either bootstrap or wilcoxon technique. The output of this function has class \sQuote{es}.
+\details{
+
+  \dQuote{firm.returns} may contain only one series. For performing
+  analysis for a single series, use \sQuote{[} with \code{drop =
+  FALSE} for subsetting the data set. See \code{\link{phys2eventtime}}
+  for more details.
+
+  \dQuote{type} currently supports:
+  \itemize{
+    \item{\dQuote{marketResidual}: uses \code{\link{marketResidual}()} to
+      extract market returns from firms return using a linear model.}
+
+    \item{\dQuote{excessReturn}: uses \code{\link{excessReturn}()} to
+      subtract market return from firm return.}
+
+    \item{\dQuote{lmAMM}: uses \code{\link{lmAMM}()} to perform
+      Augmented Market Model estimation.}
+
+    \item{\dQuote{None}: don't use any model.}
+  }
+
+    
+  The function needs firm returns as input and provides
+  argument \sQuote{type} to generate abnormal returns, if required. If
+  \sQuote{type} is \sQuote{market.residuals} then it will generate
+  abnormal returns using a market model. It also provides option to
+  estimate returns using augmented market model (AMM) which purges out
+  market returns and \sQuote{others} i.e. currency in our case
+  (\sQuote{type} as \sQuote{lmAMM}). The function computes confidence
+  interval using either bootstrap or wilcoxon technique. The output of
+  this function has class \sQuote{es}.
+
+
 }
 
 \value{
@@ -82,8 +117,9 @@
   following elements:
 
   \item{eventstudy.output}{
-	a \sQuote{matrix} containing mean/median estimate with confidence
--    interval
+    a \sQuote{matrix} containing mean/median estimate with
+    confidence interval; \sQuote{NULL} if there are no \dQuote{success}
+    \dQuote{outcomes}.
   }
 
   \item{outcomes}{a character vector having outcome of each event date:}