https://github.com/cran/spatstat
Tip revision: edc49ab1e55bf5475be2f4d0987c835f45800ebc authored by Adrian Baddeley on 08 October 2015, 13:43:38 UTC
version 1.43-0
version 1.43-0
Tip revision: edc49ab
slrm.Rd
\name{slrm}
\alias{slrm}
\title{Spatial Logistic Regression}
\description{
Fits a spatial logistic regression model
to a spatial point pattern.
}
\usage{
slrm(formula, ..., data = NULL, offset = TRUE, link = "logit",
dataAtPoints=NULL, splitby=NULL)
}
\arguments{
\item{formula}{The model formula. See Details.}
\item{\dots}{
Optional arguments passed to \code{\link{pixellate}}
determining the pixel resolution for the discretisation
of the point pattern.
}
\item{data}{
Optional. A list containing data required in the formula.
The names of entries in the list should correspond to variable
names in the formula. The entries should be point patterns,
pixel images or windows.
}
\item{offset}{
Logical flag indicating whether the model formula
should be augmented by an offset equal to the logarithm of the
pixel area.
}
\item{link}{The link function for the regression model.
A character string, specifying a link function
for binary regression.
}
\item{dataAtPoints}{Optional.
Exact values of the covariates at the data points.
A data frame, with column names corresponding to
variables in the \code{formula}, with one row for each
point in the point pattern dataset.
}
\item{splitby}{
Optional. Character string identifying a window. The window will be used
to split pixels into sub-pixels.
}
}
\details{
This function fits a Spatial Logistic Regression model
(Tukey, 1972; Agterberg, 1974) to a spatial point pattern dataset.
The logistic function may be replaced by another link function.
The \code{formula} specifies the form of the model to be fitted,
and the data to which it should be fitted. The \code{formula}
must be an \R formula with a left and right hand
side.
The left hand side of the \code{formula} is the name of the
point pattern dataset, an object of class \code{"ppp"}.
The right hand side of the \code{formula} is an expression,
in the usual \R formula syntax, representing the functional form of
the linear predictor for the model.
Each variable name that appears in the formula may be
\itemize{
\item
one of the reserved names \code{x} and \code{y},
referring to the Cartesian coordinates;
\item
the name of an entry in the list \code{data}, if this argument is given;
\item
the name of an object in the
parent environment, that is, in the environment where the call
to \code{slrm} was issued.
}
Each object appearing on the right hand side of the formula may be
\itemize{
\item a pixel image (object of class \code{"im"})
containing the values of a covariate;
\item a window (object of class \code{"owin"}), which will be
interpreted as a logical covariate which is \code{TRUE} inside the
window and \code{FALSE} outside it;
\item a \code{function} in the \R language, with arguments
\code{x,y}, which can be evaluated at any location to
obtain the values of a covariate.
}
See the Examples below.
The fitting algorithm discretises the point pattern onto a pixel grid. The
value in each pixel is 1 if there are any points of the point pattern
in the pixel, and 0 if there are no points in the pixel.
The dimensions of the pixel grid will be determined as follows:
\itemize{
\item
The pixel grid will be determined by the extra
arguments \code{\dots} if they are specified (for example the argument
\code{dimyx} can be used to specify the number of pixels).
\item
Otherwise, if the right hand side of the \code{formula} includes
the names of any pixel images containing covariate values,
these images will determine the pixel grid for the discretisation.
The covariate image with the finest grid (the smallest pixels) will
be used.
\item
Otherwise, the default pixel grid size is given by
\code{spatstat.options("npixel")}.
}
If \code{link="logit"} (the default), the algorithm fits a Spatial Logistic
Regression model. This model states that the probability
\eqn{p} that a given pixel contains a data point, is related to the
covariates through
\deqn{\log\frac{p}{1-p} = \eta}{log(p/(1-p)) = eta}
where \eqn{\eta}{eta} is the linear predictor of the model
(a linear combination of the covariates,
whose form is specified by the \code{formula}).
If \code{link="cloglog"} then the algorithm fits a model stating that
\deqn{\log(-\log(1-p)) = \eta}{log(-log(1-p)) = eta}.
If \code{offset=TRUE} (the default), the model formula will be
augmented by adding an offset term equal to the logarithm of the pixel
area. This ensures that the fitted parameters are
approximately independent of pixel size.
If \code{offset=FALSE}, the offset is not included, and the
traditional form of Spatial Logistic Regression is fitted.
}
\value{
An object of class \code{"slrm"} representing the fitted model.
There are many methods for this class, including methods for
\code{print}, \code{fitted}, \code{predict},
\code{anova}, \code{coef}, \code{logLik}, \code{terms},
\code{update}, \code{formula} and \code{vcov}.
Automated stepwise model selection is possible using
\code{\link{step}}. Confidence intervals for the parameters can be
computed using \code{\link[stats]{confint}}.
}
\seealso{
\code{\link{anova.slrm}},
\code{\link{coef.slrm}},
\code{\link{fitted.slrm}},
\code{\link{logLik.slrm}},
\code{\link{plot.slrm}},
\code{\link{predict.slrm}},
\code{\link{vcov.slrm}}
}
\references{
Agterberg, F.P. (1974)
Automatic contouring of geological maps to detect target areas for
mineral exploration.
\emph{Journal of the International Association for Mathematical Geology}
\bold{6}, 373--395.
Baddeley, A., Berman, M., Fisher, N.I., Hardegen, A., Milne, R.K.,
Schuhmacher, D., Shah, R. and Turner, R. (2010)
Spatial logistic regression and change-of-support
for spatial Poisson point processes.
\emph{Electronic Journal of Statistics}
\bold{4}, 1151--1201.
{doi: 10.1214/10-EJS581}
Tukey, J.W. (1972)
Discussion of paper by F.P. Agterberg and S.C. Robinson.
\emph{Bulletin of the International Statistical Institute}
\bold{44} (1) p. 596.
Proceedings, 38th Congress, International Statistical Institute.
}
\examples{
X <- copper$SouthPoints
slrm(X ~ 1)
slrm(X ~ x+y)
slrm(X ~ x+y, link="cloglog")
# specify a grid of 2-km-square pixels
slrm(X ~ 1, eps=2)
Y <- copper$SouthLines
Z <- distmap(Y)
slrm(X ~ Z)
slrm(X ~ Z, dataAtPoints=list(Z=nncross(X,Y,what="dist")))
dat <- list(A=X, V=Z)
slrm(A ~ V, data=dat)
}
\author{Adrian Baddeley
\email{adrian@maths.uwa.edu.au}
\url{http://www.maths.uwa.edu.au/~adrian/}
and Rolf Turner
\email{r.turner@auckland.ac.nz}
}
\keyword{spatial}
\keyword{models}