[Robast-commits] r706 - pkg/ROptEst/man

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

Author: stamats
Date: 2013-09-12 12:19:55 +0200 (Thu, 12 Sep 2013)
New Revision: 706

Modified:
   pkg/ROptEst/man/CniperPointPlotWrapper.Rd
   pkg/ROptEst/man/getReq.Rd
Log:
hint on capital letters added, documentation corrected

Modified: pkg/ROptEst/man/CniperPointPlotWrapper.Rd
===================================================================
--- pkg/ROptEst/man/CniperPointPlotWrapper.Rd	2013-09-12 10:19:28 UTC (rev 705)
+++ pkg/ROptEst/man/CniperPointPlotWrapper.Rd	2013-09-12 10:19:55 UTC (rev 706)
@@ -31,10 +31,9 @@
   invisible(NULL)
 }
 \description{
-  The wrapper takes most of arguments to the
-  cniperPointPlot function by default and gives a user
-  possibility to run the function with low number of
-  arguments
+  The wrapper \code{CniperPointPlot} (capital C!) takes most of arguments 
+  to the \code{cniperPointPlot} (lower case c!) function by default and gives 
+  a user possibility to run the function with low number of arguments.
 }
 \section{Details}{
   Calls \code{cniperPointPlot} with suitably chosen

Modified: pkg/ROptEst/man/getReq.Rd
===================================================================
--- pkg/ROptEst/man/getReq.Rd	2013-09-12 10:19:28 UTC (rev 705)
+++ pkg/ROptEst/man/getReq.Rd	2013-09-12 10:19:55 UTC (rev 706)
@@ -7,7 +7,7 @@
  respectively the number of (worst-case) outliers interval where IC1 is
  better than IC2.
 }
-\usage{getReq(Risk,neighbor,IC1,IC2,n=1,upper=15, radOrOutl=c("radius","Outlier"))}
+\usage{getReq(Risk,neighbor,IC1,IC2,n=1,upper=15)}
 \arguments{
   \item{Risk}{an object of class \code{"asGRisk"} -- the risk at which IC1 is better than IC2.}
   \item{neighbor}{ object of class \code{"Neighborhood"}; the neighborhood at which to compute the bias. }
@@ -17,9 +17,6 @@
     in the shrinking neighborhood setting of Rieder[94]. Otherwise the radius interval is scaled
     down accordingly.}
   \item{upper}{the upper bound of the radius interval in which to search}  
-  \item{radOrOutl}{ a character string specifying whether an interval of
-          radii  or a number of outliers is returned; must be one
-          of "radius" (default) and "Outlier". }
 }
 %\details{}
 \value{The radius interval (given by its endpoints) where \code{IC1} is better than \code{IC2}