Revision c9b2c621c3bff55aaa77646dc1ba7316765cd7e4 authored by Adrian Baddeley on 25 April 2013, 00:00:00 UTC, committed by Gabor Csardi on 25 April 2013, 00:00:00 UTC
1 parent f86606a
summary.ppp.Rd
\name{summary.ppp}
\alias{summary.ppp}
\title{Summary of a Point Pattern Dataset}
\description{
Prints a useful summary of a point pattern dataset.
}
\usage{
\method{summary}{ppp}(object, \dots, checkdup=TRUE)
}
\arguments{
\item{object}{
Point pattern (object of class \code{"ppp"}).
}
\item{\dots}{
Ignored.
}
\item{checkdup}{
Logical value indicating whether to check
for the presence of duplicate points.
}
}
\details{
A useful summary of the point pattern \code{object} is printed.
This is a method for the generic function \code{\link{summary}}.
If \code{checkdup=TRUE}, the pattern will be checked for the
presence of dublicate points, using \code{\link{duplicated.ppp}}.
This can be time-consuming if the pattern contains many points,
so the checking can be disabled by setting \code{checkdup=FALSE}.
If the point pattern was generated by simulation
using \code{\link{rmh}}, the parameters of the algorithm
are printed.
}
\seealso{
\code{\link{summary}},
\code{\link{summary.owin}},
\code{\link{print.ppp}}
}
\examples{
summary(cells) # plain vanilla point pattern
# multitype point pattern
\testonly{lansing <- lansing[seq(1, lansing$n, length=40)]}
summary(lansing) # tabulates frequencies of each mark
# numeric marks
\testonly{longleaf <- longleaf[seq(1, longleaf$n, length=40)]}
summary(longleaf) # prints summary.default(x$marks)
# weird polygonal window
summary(demopat) # describes it
}
\author{Adrian Baddeley
\email{Adrian.Baddeley@csiro.au}
\url{http://www.maths.uwa.edu.au/~adrian/}
and Rolf Turner
\email{r.turner@auckland.ac.nz}
}
\keyword{spatial}
\keyword{methods}
Computing file changes ...