[Eventstudies-commits] r206 - pkg/man

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

Author: chiraganand
Date: 2014-03-18 22:20:31 +0100 (Tue, 18 Mar 2014)
New Revision: 206

Modified:
   pkg/man/remap.event.reindex.Rd
Log:
Added fixme, description needs to change.

Modified: pkg/man/remap.event.reindex.Rd
===================================================================
--- pkg/man/remap.event.reindex.Rd	2014-03-18 21:16:23 UTC (rev 205)
+++ pkg/man/remap.event.reindex.Rd	2014-03-18 21:20:31 UTC (rev 206)
@@ -1,13 +1,17 @@
 \name{remap.event.reindex}
 \alias{remap.event.reindex}
 
-\title{This function sets the value at event date to be 100 and the other values relative to this value.}
+\title{This function remaps the event date to 100, and other values
+  relative to the remapped event date.}
 
+%% FIXME: needs to be rewritten.
+\description{A function which consumes a zoo object where there are lots
+  of events (as columns). The contents are all levels.  For each column,
+  the event date value is set to 100 and all other values are scaled
+  accordingly.  It's input is a zoo object which is the first component of
+  the list returned by phys2eventtime.
+}
 
-\description{A function which consumes a zoo object where there are lots of events (as columns). The contents are all levels.
-For each column, the event date value is set to 100 and all other values are scaled accordingly.
-It's input is a zoo object which is the first component of the list returned by phys2eventtime.}
-
 \usage{remap.event.reindex(z)}
 
 \arguments{