[Gsdesign-commits] r151 - pkg/man

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

Author: keaven
Date: 2009-05-13 20:02:08 +0200 (Wed, 13 May 2009)
New Revision: 151

Modified:
   pkg/man/gsDesign.Rd
   pkg/man/plot.gsDesign.Rd
   pkg/man/sfLDPocock.Rd
   pkg/man/sfexp.Rd
   pkg/man/sflogistic.Rd
   pkg/man/testutils.Rd
Log:
.Rd format updates

Modified: pkg/man/gsDesign.Rd
===================================================================
--- pkg/man/gsDesign.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/gsDesign.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -162,6 +162,7 @@
 plot(x, plottype=2)
 
 # same design, but with relative sample sizes
-gsDesign(k=4, timing=timing, sfu=sfPoints, sfupar=sfup, sfl=sfPoints, sflpar=sflp)
+gsDesign(k=4, timing=timing, sfu=sfPoints, sfupar=sfup, sfl=sfPoints,
+sflpar=sflp)
 }
 \keyword{design}

Modified: pkg/man/plot.gsDesign.Rd
===================================================================
--- pkg/man/plot.gsDesign.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/plot.gsDesign.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -35,7 +35,8 @@
 	7=B-values at boundaries. 
 
 	Character values for \code{plottype} may also be entered: \code{"Z"} for plot
-type 1,\code{"power"} for plot type 2, \code{"thetahat"} for plot type 3,
+type 1,
+\code{"power"} for plot type 2, \code{"thetahat"} for plot type 3,
 	\code{"CP"} for plot type 4, \code{"sf"} for plot type 5, \code{"ASN"}, 
 \code{"N"} or \code{"n"} for plot type 6, and \code{"B"}, \code{"B-val"} or 
 \code{"B-value"} for plot type 7.}

Modified: pkg/man/sfLDPocock.Rd
===================================================================
--- pkg/man/sfLDPocock.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/sfLDPocock.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -30,7 +30,7 @@
 O'Brien-Fleming bound is implemented in the function (\code{sfLDOF()}):
 \deqn{f(t; \alpha)=2-2\Phi\left(\Phi^{-1}(1-\alpha/2)/ t^{1/2}\right).}{%
 f(t; alpha)=2-2*Phi(Phi^(-1)(1-alpha/2)/t^(1/2)\right).}
-The Lan-DeMets (1983) spending function to approximate a Pocock design is implemented in the function {\code{sfLDPocock()}}:
+The Lan-DeMets (1983) spending function to approximate a Pocock design is implemented in the function \code{sfLDPocock()}:
 \deqn{f(t;\alpha)=ln(1+(e-1)t).}{f(t;alpha)=ln(1+(e-1)t).}
 As shown in examples below, other spending functions can be used to get as good or better approximations to Pocock and
 O'Brien-Fleming bounds. In particular, O'Brien-Fleming bounds can be closely approximated using \code{\link{sfExponential}}.

Modified: pkg/man/sfexp.Rd
===================================================================
--- pkg/man/sfexp.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/sfexp.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -41,7 +41,7 @@
 f(t; alpha)=2-2*Phi(Phi^(-1)(1-alpha/2)/t^(1/2)).}
 }
 \seealso{\link{Spending function overview}, \code{\link{gsDesign}}, \link{gsDesign package overview}}
-\note{The manual shows how to closely approximate an O'Brien-Fleming design using \code{sfExponential()}.
+\note{The manual shows how to use \code{sfExponential()} to closely approximate an O'Brien-Fleming design.
 An example is given below.
 The manual is not linked to this help file, but is available in library/gsdesign/doc/gsDesignManual.pdf
 in the directory where R is installed.}

Modified: pkg/man/sflogistic.Rd
===================================================================
--- pkg/man/sflogistic.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/sflogistic.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -130,7 +130,8 @@
         "Extreme value 2", "Beta distribution"))
 }
 # do comparison for a design with conservative early spending
-# note that Cauchy spending function is quite different from the others
+# note that Cauchy spending function is quite different
+# from the others
 param <- c(.25, .5, .05, .1)
 plotsf(.025, t, param)
 }

Modified: pkg/man/testutils.Rd
===================================================================
--- pkg/man/testutils.Rd	2009-05-12 13:37:42 UTC (rev 150)
+++ pkg/man/testutils.Rd	2009-05-13 18:02:08 UTC (rev 151)
@@ -29,9 +29,13 @@
   \item{varname}{character string defining the name of the input variable as sent into the function by the caller. 
   This is used primarily as a mechanism to specify the name of the variable being tested when \code{checkRange} is being called
   within a function.}
-  \item{tol}{numeric scalar defining the tolerance to use in testing the intervals of the \code{\link{checkRange}} function.}
+  \item{tol}{numeric scalar defining the tolerance to use in testing the intervals of the 
+
+\code{\link{checkRange}} function.}
   \item{\dots}{For the \code{\link{checkScalar}} and \code{\link{checkVector}} functions, this input represents additional 
-  arguments sent directly to the \code{\link{checkRange}} function. For the \code{\link{checkLengths}} function, this input
+  arguments sent directly to the \code{\link{checkRange}} function. For the 
+
+\code{\link{checkLengths}} function, this input
   represents the arguments to check for equal lengths.}
   \item{allowSingle}{logical flag. If \code{TRUE}, arguments that are vectors comprised of a single element are not included in 
   the comparative length test in the \code{\link{checkLengths}} function. Partial matching on the name of this argument is not