[Eventstudies-commits] r115 - pkg/man

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

Author: chiraganand
Date: 2013-08-06 17:46:54 +0200 (Tue, 06 Aug 2013)
New Revision: 115

Modified:
   pkg/man/phys2eventtime.Rd
Log:
Added explanation for taking previous date if an event date is not found.


Modified: pkg/man/phys2eventtime.Rd
===================================================================
--- pkg/man/phys2eventtime.Rd	2013-08-06 11:08:14 UTC (rev 114)
+++ pkg/man/phys2eventtime.Rd	2013-08-06 15:46:54 UTC (rev 115)
@@ -6,7 +6,7 @@
 }
 
 \description{
-Given a zoo time-series vector and an event date, it converts the physical date to the event date. The event date becomes zero and all other dates shift accordingly.
+Given a zoo time-series and event dates, it converts the physical dates to event dates. The event date becomes zero and all other dates shift accordingly.
 }
 
 \usage{
@@ -16,12 +16,17 @@
 \arguments{
   \item{z}{Time series data for which event frame is to be generated.}
 
-  \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{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. See details.}
 
   \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.}
 
 }
 
+\details{ If an event date is not found, the function takes the previous
+  value of date in index(z) as the event date.  }
+
 \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.
 }