[Eventstudies-commits] r191 - pkg/man

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

Author: chiraganand
Date: 2014-03-16 13:03:23 +0100 (Sun, 16 Mar 2014)
New Revision: 191

Modified:
   pkg/man/eesPlot.Rd
Log:
Fixed formatting, added fixme for the example: doesn't work.

Modified: pkg/man/eesPlot.Rd
===================================================================
--- pkg/man/eesPlot.Rd	2014-03-16 11:42:20 UTC (rev 190)
+++ pkg/man/eesPlot.Rd	2014-03-16 12:03:23 UTC (rev 191)
@@ -5,29 +5,53 @@
 Plotting clustered and unclustered extreme events retuns.
 }
 
-\description{
-This function replicates result of Patnaik, Shah and Singh (2013). The function creates an event study plot that treats all clustered events as one event. It plots both the lower and upper tail events and the events are defined based on the cut off probability values provided (in percentage terms).}
+\description{The function creates an event study plot that treats all
+  clustered events as one event. It plots both the lower and upper tail
+  events and the events are defined based on the cut off probability
+  values provided (in percentage terms).This function replicates result
+  of Patnaik, Shah, and Singh (2013).}
 
-
 \usage{
-eesPlot(z, response.series.name, event.series.name, titlestring, ylab, width, prob.value)
+eesPlot(z,
+        response.series.name,
+        event.series.name,
+        titlestring,
+        ylab,
+        width,
+        prob.value)
 }
 
 \arguments{
-  \item{z}{Data object with both response and event series on which event study is to be performed}
-  \item{response.series.name}{Column name of the series in 'z' on which response is to be observed }
-  \item{event.series.name}{Column name of the series in 'z' on which event is to be defined }
-  \item{titlestring}{Title for event study plot}
-  \item{ylab}{Y-axis label}
-  \item{width}{Width for event study plot}
-  \item{prob.value}{Cut-off values in the probability distribution (in percentage terms)} 
+  
+  \item{z}{Data object with both response and event series on which
+    event study is to be performed.}
+
+  \item{response.series.name}{Column name of the series in \sQuote{z} on which
+    response is to be observed.}
+
+  \item{event.series.name}{Column name of the series in \sQuote{z} on which
+    event is to be defined.}
+
+  \item{titlestring}{Title for event study plot.}
+
+  \item{ylab}{Y-axis label of the plot.}
+
+  \item{width}{Width for event study plot.}
+
+  \item{prob.value}{Cut-off values in the probability distribution (in
+    percentage terms).}
 }
 
-\value{
-A plot of the response series with lower and upper tail events defined on the event series.}
+\value{A plot of the response series with lower and upper tail events
+  defined on the event series.}
 
+%% FIXME: example doesn't work!
 \examples{
 library(eventstudies)
 data(eesData)
-eesPlot(z=eesData, response.series.name="nifty", event.series.name="sp500",titlestring="S&P500", ylab="(Cum.) change in NIFTY")
-}
\ No newline at end of file
+eesPlot(z = eesData,
+        response.series.name = "nifty",
+        event.series.name = "sp500",
+        titlestring = "S&P500",
+        ylab = "(Cum.) change in NIFTY")
+}