tweak dpqr docs: +cumulative (PR#18916), +/densities, markup

git-svn-id: https://svn.r-project.org/R/trunk@88459 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: smeyer

src/library/stats/man/Beta.Rd

@@ -29,8 +29,9 @@ rbeta(n, shape1, shape2, ncp = 0)
     is taken to be the number required.}
   \item{shape1, shape2}{non-negative parameters of the Beta distribution.}
   \item{ncp}{non-centrality parameter.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \details{
@@ -67,9 +68,10 @@ rbeta(n, shape1, shape2, ncp = 0)
   non-centrality parameter \eqn{\lambda}, see \link{Chisquare}.
 }
 \value{
-  \code{dbeta} gives the density, \code{pbeta} the distribution
-  function, \code{qbeta} the quantile function, and \code{rbeta}
-  generates random deviates.
+  \code{dbeta} gives the density,
+  \code{pbeta} is the cumulative distribution function, and
+  \code{qbeta} is the quantile function of the Beta distribution.
+  \code{rbeta} generates random deviates.
 
   Invalid arguments will result in return value \code{NaN}, with a warning.
 

src/library/stats/man/Binomial.Rd

@@ -31,14 +31,16 @@ rbinom(n, size, prob)
     is taken to be the number required.}
   \item{size}{number of trials (zero or more).}
   \item{prob}{probability of success on each trial.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \value{
-  \code{dbinom} gives the density, \code{pbinom} gives the distribution
-  function, \code{qbinom} gives the quantile function and \code{rbinom}
-  generates random deviates.
+  \code{dbinom} gives the density,
+  \code{pbinom} is the cumulative distribution function, and
+  \code{qbinom} is the quantile function of the binomial distribution.
+  \code{rbinom} generates random deviates.
 
   If \code{size} is not an integer, \code{NaN} is returned.
 

src/library/stats/man/Cauchy.Rd

@@ -27,23 +27,24 @@ rcauchy(n, location = 0, scale = 1)
   \item{n}{number of observations. If \code{length(n) > 1}, the length
     is taken to be the number required.}
   \item{location, scale}{location and scale parameters.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \value{
-  \code{dcauchy}, \code{pcauchy}, and \code{qcauchy} are respectively
-  the density, distribution function and quantile function of the Cauchy
-  distribution.  \code{rcauchy} generates random deviates from the
-  Cauchy.
-  
+  \code{dcauchy} gives the density,
+  \code{pcauchy} is the cumulative distribution function, and
+  \code{qcauchy} is the quantile function of the Cauchy distribution.
+  \code{rcauchy} generates random deviates.
+
   The length of the result is determined by \code{n} for
   \code{rcauchy}, and is the maximum of the lengths of the
-  numerical arguments for the other functions.  
-  
+  numerical arguments for the other functions.
+
   The numerical arguments other than \code{n} are recycled to the
   length of the result.  Only the first elements of the logical
-  arguments are used.    
+  arguments are used.
 }
 \details{
   If \code{location} or \code{scale} are not specified, they assume
@@ -73,7 +74,7 @@ rcauchy(n, location = 0, scale = 1)
 }
 \seealso{
   \link{Distributions} for other standard distributions, including
-  \code{\link{dt}} for the t distribution which generalizes
+  \code{\link{dt}} for the \eqn{t} distribution which generalizes
   \code{dcauchy(*, l = 0, s = 1)}.
 }
 \examples{

src/library/stats/man/Chisquare.Rd

@@ -29,18 +29,20 @@ rchisq(n, df, ncp = 0)
     is taken to be the number required.}
   \item{df}{degrees of freedom (non-negative, but can be non-integer).}
   \item{ncp}{non-centrality parameter (non-negative).}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}, unless for \code{df=0} and
     when \code{ncp} is missing, where the central chi-squared
     distribution function is based
     on \code{\link{pgamma}()}; in this case, probabilities are
     \eqn{P[X < x]} when \code{lower.tail} is true, and \eqn{P[X \ge x]}, otherwise.}
 }
 \value{
-  \code{dchisq} gives the density, \code{pchisq} gives the distribution
-  function, \code{qchisq} gives the quantile function, and \code{rchisq}
-  generates random deviates.
+  \code{dchisq} gives the density,
+  \code{pchisq} is the cumulative distribution function, and
+  \code{qchisq} is the quantile function of the chi-squared distribution.
+  \code{rchisq} generates random deviates.
 
   Invalid arguments will result in return value \code{NaN}, with a warning.
 

src/library/stats/man/Distributions.Rd

@@ -1,13 +1,13 @@
 % File src/library/stats/man/Distributions.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 2010-2011 R Core Team
+% Copyright 2010-2025 R Core Team
 % Distributed under GPL 2 or later
 
 \name{Distributions}
 \alias{distribution}
 \alias{distributions}
 \alias{Distributions}
-\title{Distributions in the stats package}
+\title{Distributions in the \pkg{stats} Package}
 \description{
   Density, cumulative distribution function, quantile function and random
   variate generation for many standard probability distributions are
@@ -40,6 +40,8 @@
 
   For the log-normal distribution see \code{\link{dlnorm}}.
 
+  For the logistic distribution see \code{\link{dlogis}}.
+
   For the multinomial distribution see \code{\link{dmultinom}}.
 
   For the negative binomial distribution see \code{\link{dnbinom}}.
@@ -48,22 +50,22 @@
 
   For the Poisson distribution see \code{\link{dpois}}.
 
-  For the Student's t distribution see \code{\link{dt}}.
+  For the Student's \eqn{t} distribution see \code{\link{dt}}.
 
   For the uniform distribution see \code{\link{dunif}}.
 
   For the Weibull distribution see \code{\link{dweibull}}.
 
   For less common distributions of test statistics see
-  \code{\link{pbirthday}}, \code{\link{dsignrank}},
+  \code{\link{pbirthday}}, \code{\link{dsignrank}}, \code{\link{psmirnov}},
   \code{\link{ptukey}} and \code{\link{dwilcox}} (and see the
   \sQuote{See Also} section of \code{\link{cor.test}}).
 }
 \seealso{
   \code{\link{RNG}} about random number generation in \R.
 
-  The CRAN task view on distributions,
+  The CRAN task view on probability distributions,
   \url{https://CRAN.R-project.org/view=Distributions},
-  mentioning several CRAN packages for additional distributions.
+  lists \R packages that provide additional distributions.
 }
 \keyword{distribution}

src/library/stats/man/Exponential.Rd

@@ -27,20 +27,21 @@ rexp(n, rate = 1)
   \item{n}{number of observations. If \code{length(n) > 1}, the length
     is taken to be the number required.}
   \item{rate}{vector of rates.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \value{
   \code{dexp} gives the density,
-  \code{pexp} gives the distribution function,
-  \code{qexp} gives the quantile function, and
+  \code{pexp} is the cumulative distribution function, and
+  \code{qexp} is the quantile function of the exponential distribution.
   \code{rexp} generates random deviates.
 
   The length of the result is determined by \code{n} for
   \code{rexp}, and is the maximum of the lengths of the
-  numerical arguments for the other functions.  
-  
+  numerical arguments for the other functions.
+
   The numerical arguments other than \code{n} are recycled to the
   length of the result.  Only the first elements of the logical
   arguments are used.

src/library/stats/man/Fdist.Rd

@@ -28,14 +28,15 @@ rf(n, df1, df2, ncp)
     is taken to be the number required.}
   \item{df1, df2}{degrees of freedom.  \code{Inf} is allowed.}
   \item{ncp}{non-centrality parameter. If omitted the central F is assumed.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \value{
   \code{df} gives the density,
-  \code{pf} gives the distribution function
-  \code{qf} gives the quantile function, and
+  \code{pf} is the cumulative distribution function, and
+  \code{qf} is the quantile function of the F distribution.
   \code{rf} generates random deviates.
 
   Invalid arguments will result in return value \code{NaN}, with a warning.
@@ -115,7 +116,7 @@ rf(n, df1, df2, ncp)
 \seealso{
   \link{Distributions} for other standard distributions, including
   \code{\link{dchisq}} for chi-squared and \code{\link{dt}} for Student's
-  t distributions.
+  \eqn{t} distributions.
 }
 \examples{
 ## Equivalence of pt(.,nu) with pf(.^2, 1,nu):

src/library/stats/man/GammaDist.Rd

@@ -32,16 +32,16 @@ rgamma(n, shape, rate = 1, scale = 1/rate)
   \item{rate}{an alternative way to specify the scale.}
   \item{shape, scale}{shape and scale parameters.  Must be positive,
     \code{scale} strictly.}
-  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities \eqn{p}
-    are returned as \eqn{log(p)}.}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities/densities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X < x]}, otherwise, \eqn{P[X \ge x]} (exceptionally not
     \emph{cadlag} here, to ensure, e.g., \code{pgamma(0, shape=0)} remains zero).}
 }
 \value{
   \code{dgamma} gives the density,
-  \code{pgamma} gives the distribution function,
-  \code{qgamma} gives the quantile function, and
+  \code{pgamma} is the cumulative distribution function, and
+  \code{qgamma} is the quantile function of the Gamma distribution.
   \code{rgamma} generates random deviates.
 
   Invalid arguments will result in return value \code{NaN}, with a warning.
@@ -73,7 +73,8 @@ rgamma(n, shape, rate = 1, scale = 1/rate)
 
   The cumulative hazard \eqn{H(t) = - \log(1 - F(t))}{H(t) = - log(1 - F(t))}
   is
-\preformatted{-pgamma(t, ..., lower = FALSE, log = TRUE)
+\preformatted{
+    -pgamma(t, ..., lower = FALSE, log = TRUE)
 }
 
   Note that for smallish values of \code{shape} (and moderate

src/library/stats/man/Geometric.Rd

@@ -27,8 +27,9 @@ rgeom(n, prob)
   \item{n}{number of observations. If \code{length(n) > 1}, the length
     is taken to be the number required.}
   \item{prob}{probability of success in each trial. \code{0 < prob <= 1}.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \details{
@@ -44,8 +45,8 @@ rgeom(n, prob)
 }
 \value{
   \code{dgeom} gives the density,
-  \code{pgeom} gives the distribution function,
-  \code{qgeom} gives the quantile function, and
+  \code{pgeom} is the cumulative distribution function, and
+  \code{qgeom} is the quantile function of the geometric distribution.
   \code{rgeom} generates random deviates.
 
   Invalid \code{prob} will result in return value \code{NaN}, with a warning.

src/library/stats/man/Hypergeometric.Rd

@@ -31,14 +31,15 @@ rhyper(nn, m, n, k)
   \item{p}{probability, it must be between 0 and 1.}
   \item{nn}{number of observations.  If \code{length(nn) > 1}, the length
     is taken to be the number required.}
-  \item{log, log.p}{logical; if TRUE, probabilities p are given as log(p).}
-  \item{lower.tail}{logical; if TRUE (default), probabilities are
+  \item{log, log.p}{logical; if \code{TRUE}, probabilities
+    are given as logarithms.}
+  \item{lower.tail}{logical; if \code{TRUE} (default), probabilities are
     \eqn{P[X \le x]}, otherwise, \eqn{P[X > x]}.}
 }
 \value{
   \code{dhyper} gives the density,
-  \code{phyper} gives the distribution function,
-  \code{qhyper} gives the quantile function, and
+  \code{phyper} is the cumulative distribution function, and
+  \code{qhyper} is the quantile function of the hypergeometric distribution.
   \code{rhyper} generates random deviates.
 
   Invalid arguments will result in return value \code{NaN}, with a warning.