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
42
43
44
45
46
47
48
49
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tol.contour.R
\name{tol.contour}
\alias{tol.contour}
\title{Plot tolerance contours}
\usage{
tol.contour(pim, test = c("upper", "lower", "two-sided"), ...)
}
\arguments{
\item{pim}{A pixel \code{\link[spatstat.geom]{im}}age of \emph{p}-values,
typically obtained from a call to \code{\link{tolerance}}, computed with
respect to a test for elevated risk.}
\item{test}{An optional character string giving the type of manipulation to
be applied to the \emph{p}-values, corresponding to a test for significantly
elevated risk (\code{"upper"}; default); for reduced risk (\code{"lower"});
or for both (\code{"two-sided"}).}
\item{...}{Additional arguments to be passed to \code{\link{contour}}.
Commonly used options include \code{add} (to superimpose the contours upon
an existing plot); \code{levels} (to control the specific significance
levels at which to delineate the \emph{p}-values); and \code{lty} or
\code{lwd} for aesthetics.}
}
\value{
Opens a new graphics device and displays a \code{\link{contour}}
plot if \code{add = FALSE}, otherwise adds the contours to the plot in the
existing active graphics device.
}
\description{
Draw contours based on a \emph{p}-value matrix.
}
\details{
Note that no checks on the numeric content of \code{pim} are made. The
function assumes the pixel \code{\link[spatstat.geom]{im}}age of \emph{p}-values
in \code{pim} is supplied with respect to an upper-tailed test for elevated
risk (this is exactly the way the \emph{p}-value surface is returned when
\code{\link{tolerance}} is used). This is important if one makes subsequent
use of \code{test}, which manipulates the \emph{p}-values to draw at desired
significance \code{levels}.
}
\examples{
# See ?tolerance
}
\author{
T. M. Davies
}
|
