File: quantile.Rd

package info (click to toggle)
r-cran-raster 3.6-31-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 3,300 kB
  • sloc: cpp: 2,367; ansic: 1,572; sh: 13; makefile: 2
file content (41 lines) | stat: -rw-r--r-- 947 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
\name{quantile}

\docType{methods}

\alias{quantile}
\alias{quantile,Raster-method}

\title{Raster quantiles}

\description{
Compute quantiles for the cell values of a RasterLayer. If you want to compute quantiles for each cell across a number of layers, you can use \code{\link{calc}(x, fun=quantile)}. 
}

\usage{
quantile(x, ...) 
}

\arguments{
  \item{x}{Raster object}
  \item{...}{Additional arguments: \code{na.rm=TRUE}, \code{ncells=NULL}, and additional arguments to the stats::quantile function, see \code{\link[stats]{quantile}}}  
       ncells can be used to set the number of cells to be sampled, for very large raster datasets.
}

\value{
A vector of quantiles
}

\seealso{ \code{\link[raster]{density}}, \code{\link[raster]{cellStats}}  }



\examples{
r <- raster(ncol=100, nrow=100)
values(r) <- rnorm(ncell(r), 0, 50)
quantile(r)
quantile(r, probs = c(0.25, 0.75), type=7,names = FALSE)
}

\keyword{methods}
\keyword{spatial}