R devel - May 2002 - Documentation Bugs (PR#1618)

Just a few documentation "bugs" that I've noticed recently.

1.  In the help for (dpqr)weibull(), the formula given for the
    variance of a Weibull is wrong.  The correct formula is

      b^2 * sqrt(gamma(1 + 2/a) - (gamma(1 + 1/a))^2))

    Note that I've also changed Gamma to gamma, which I think is
    preferable since this is actually the name of the gamma() function
    in R (whereas Gamma() is quite a different animal).

2.  The help for quantile() function (in base) refers to the function
    ecdf(), but doesn't mention that it is in package stepfun (which
    is not loaded by default).  It would be helpful if it did.

3.  There's a typo in the help for optim(): "comprehansive".

-- 
Brett Presnell
Department of Statistics
University of Florida
http://www.stat.ufl.edu/~presnell/


Version:
 platform = sparc-sun-solaris2.6
 arch = sparc
 os = solaris2.6
 system = sparc, solaris2.6
 status = Patched
 major = 1
 minor = 5.0
 year = 2002
 month = 05
 day = 11
 language = R

Search Path:
 .GlobalEnv, package:ctest, Autoloads, package:base

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

>>>>> "Brett" == Brett Presnell
<presnell@stat.ufl.edu> writes:
    Brett> Just a few documentation "bugs" that I've noticed
    Brett> recently.

Thank you!

    Brett> 1.  In the help for (dpqr)weibull(), the formula
    Brett> given for the variance of a Weibull is wrong.  

yes..

    Brett> The correct formula is

    Brett>       b^2 * sqrt(gamma(1 + 2/a) - (gamma(1 + 1/a))^2))

which is even wronger, but I'm sure you meant

         	 b^2 *     (gamma(1 + 2/a) - (gamma(1 + 1/a))^2)


    Brett>     Note that I've also changed Gamma to gamma, which
    Brett> I think is preferable since this is actually the name
    Brett> of the gamma() function in R (whereas Gamma() is
    Brett> quite a different animal).

(but in LaTeX, that's  \Gamma  and that's why we have used it
 even for the non-latex formula (you see in the text and html
 version of help).

    Brett> 2.  The help for quantile() function (in base) refers
    Brett> to the function ecdf(), but doesn't mention that it
    Brett> is in package stepfun (which is not loaded by
    Brett> default).  It would be helpful if it did.

yes, it seems, thank you; I'm adding it.

    Brett> 3.  There's a typo in the help for optim():
    Brett> "comprehansive".

(BDR has already fixed this).

Thanks once more!

Martin Maechler <maechler@stat.math.ethz.ch>
http://stat.ethz.ch/~maechler/
Seminar fuer Statistik, ETH-Zentrum  LEO C16	Leonhardstr. 27
ETH (Federal Inst. Technology)	8092 Zurich	SWITZERLAND
phone: x-41-1-632-3408		fax: ...-1228			<><

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._