https://github.com/cran/spatstat
Revision b77682fe848e4f527e2236d867c299cc74945e27 authored by Adrian Baddeley on 19 December 2007, 06:23:13 UTC, committed by cran-robot on 19 December 2007, 06:23:13 UTC
1 parent f580af0
Raw File
Tip revision: b77682fe848e4f527e2236d867c299cc74945e27 authored by Adrian Baddeley on 19 December 2007, 06:23:13 UTC
version 1.12-4
Tip revision: b77682f
is.multitype.ppp.Rd
\name{is.multitype.ppp}
\alias{is.multitype.ppp}
\title{Test Whether A Point Pattern is Multitype}
\description{
  Tests whether a point pattern has ``marks''
  attached to the points which classify the points into several types.
}
\usage{
  \method{is.multitype}{ppp}(X, na.action="warn", \dots) 
}
\arguments{
  \item{X}{
    Point pattern (object of class \code{"ppp"})
  }
  \item{na.action}{
    String indicating what to do if \code{NA} values are
    encountered amongst the marks.
    Options are \code{"warn"}, \code{"fatal"} and \code{"ignore"}.
  }
  \item{\dots}{
    Ignored.
  }
}
\value{
  Logical value, equal to \code{TRUE} if \code{X} is a multitype point pattern.
}
\details{
  ``Marks'' are observations attached to each point of a point pattern.
  For example the \code{\link{longleaf}} dataset contains the locations
  of trees, each tree being marked by its diameter;
  the \code{\link{amacrine}} dataset gives the locations of cells
  of two types (on/off) and the type of cell may be regarded as a mark attached
  to the location of the cell.

  This function tests whether the point pattern \code{X}
  contains or involves marked points, \bold{and} that the
  marks are a factor.
  It is a method for the generic function \code{\link{is.multitype}}.
  
  For example, the \code{\link{amacrine}}
  dataset is multitype (there are two types of cells, on and off),
  but the \code{\link{longleaf}} dataset is \emph{not} multitype
  (the marks are real numbers).

  The argument \code{na.action} determines what action will be taken
  if the point pattern has a vector of marks but some or all of the
  marks are \code{NA}. Options are   \code{"fatal"} to cause a fatal
  error; \code{"warn"} to issue a warning and then return \code{TRUE};
  and \code{"ignore"} to take no action except returning \code{TRUE}.
}
\seealso{
  \code{\link{is.multitype}},
  \code{\link{is.multitype.ppm}}
}
\examples{
   data(cells)
   is.multitype(cells)  #FALSE - no marks
   data(longleaf)
   is.multitype(longleaf) #FALSE - real valued marks
   data(amacrine)
   is.multitype(amacrine) #TRUE
}
\author{Adrian Baddeley
  \email{adrian@maths.uwa.edu.au}
  \url{http://www.maths.uwa.edu.au/~adrian/}
  and Rolf Turner
  \email{rolf@math.unb.ca}
  \url{http://www.math.unb.ca/~rolf}
}
\keyword{spatial}
\keyword{manip}
back to top