[Eventstudies-commits] r370 - pkg/man

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

Author: chiraganand
Date: 2014-10-08 00:40:11 +0200 (Wed, 08 Oct 2014)
New Revision: 370

Modified:
   pkg/man/phys2eventtime.Rd
Log:
Added information about date time class of events when column and a note on usage of findInterval.

Modified: pkg/man/phys2eventtime.Rd
===================================================================
--- pkg/man/phys2eventtime.Rd	2014-10-07 22:39:09 UTC (rev 369)
+++ pkg/man/phys2eventtime.Rd	2014-10-07 22:40:11 UTC (rev 370)
@@ -31,14 +31,13 @@
 
   \dQuote{events} object contains two columns: \dQuote{name}
   consists of names of the event, and \dQuote{when} is the
-  respective event identifier. For instance, if \sQuote{z} is a matrix
-  of class \pkg{xts} with 10 stocks over 300 days, the names of stocks
-  in \sQuote{z} is the superset of names for the event and the time
-  period (i.e., 300 days) will be the superset for defining event dates.
+  respective event time. \dQuote{when} should be one of
+  \sQuote{date-time} or \sQuote{Date} classes.
+
   If an event date does not lie within this period, the function
   approximates to the nearest previous date using
-  \code{\link{findInterval}}. Note that findInterval assumes the index
-  of \sQuote{z} is non-decreasing.
+  \code{\link{findInterval}}. Note that \sQuote{findInterval} assumes the
+  index of \sQuote{z} is non-decreasing.
 
   The argument \dQuote{width} provides the user with an option to define
   successful events as those that have data within a window around the