https://github.com/cran/spatstat
Tip revision: 9f84c79450f33061219ca8cc5518816c31a9be64 authored by Adrian Baddeley on 21 November 2017, 07:39:44 UTC
version 1.54-0
version 1.54-0
Tip revision: 9f84c79
quantile.ewcdf.Rd
\name{quantile.ewcdf}
\alias{quantile.ewcdf}
\title{
Quantiles of Weighted Empirical Cumulative Distribution Function
}
\description{
Compute quantiles of a weighted empirical cumulative distribution function.
}
\usage{
\method{quantile}{ewcdf}(x, probs = seq(0, 1, 0.25),
names = TRUE, \dots,
normalise = TRUE, type=1)
}
\arguments{
\item{x}{
A weighted empirical cumulative distribution function
(object of class \code{"ewcdf"}, produced by \code{\link{ewcdf}})
for which the quantiles are desired.
}
\item{probs}{
probabilities for which the quantiles are desired.
A numeric vector of values between 0 and 1.
}
\item{names}{
Logical. If \code{TRUE}, the resulting vector of quantiles is
annotated with names corresponding to \code{probs}.
}
\item{\dots}{
Ignored.
}
\item{normalise}{
Logical value indicating whether \code{x} should first be normalised
so that it ranges between 0 and 1.
}
\item{type}{
Integer specifying the type of quantile to be calculated,
as explained in \code{\link[stats]{quantile.default}}.
Only types 1 and 2 are currently implemented.
}
}
\details{
This is a method for the generic \code{\link[stats]{quantile}}
function for the class \code{ewcdf} of empirical weighted cumulative
distribution functions.
The quantile for a probability \code{p} is computed
as the right-continuous inverse of the cumulative
distribution function \code{x} (assuming \code{type=1}, the default).
If \code{normalise=TRUE} (the default),
the weighted cumulative function \code{x} is first normalised to
have total mass \code{1} so that it can be interpreted as a
cumulative probability distribution function.
}
\value{
Numeric vector of quantiles, of the same length as \code{probs}.
}
\seealso{
\code{\link{ewcdf}},
\code{\link[stats]{quantile}}
}
\examples{
z <- rnorm(50)
w <- runif(50)
Fun <- ewcdf(z, w)
quantile(Fun, c(0.95,0.99))
}
\author{
\spatstatAuthors
and Kevin Ummel.
}
\keyword{spatial}
\keyword{nonparametric}