File: plot.studpermutest.Rd

package info (click to toggle)
r-cran-spatstat.explore 3.7-0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,704 kB
  • sloc: ansic: 4,104; sh: 13; makefile: 5
file content (118 lines) | stat: -rw-r--r-- 3,727 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
\name{plot.studpermutest}
\alias{plot.studpermutest}
\title{
  Plot a Studentised Permutation Test
}
\description{
  Plot the result of the studentised permutation test.
}
\usage{
  \method{plot}{studpermutest}(x, fmla, \dots,
          lty = NULL, col = NULL, lwd = NULL,
          lty.theo = NULL, col.theo = NULL, lwd.theo = NULL,
          lwd.mean = if (meanonly) 1 else NULL,
          lty.mean = lty, col.mean = col,
          separately = FALSE, meanonly = FALSE,
          main = if (meanonly) "group means" else NULL,
          xlim = NULL, ylim = NULL, ylab = NULL,
          legend = !add, legendpos = "topleft", lbox = FALSE, add = FALSE)
}
\arguments{
  \item{x}{
    An object of class \code{"studpermutest"} generated by
    \code{\link{studpermu.test}} and representing the result of a
    studentised permutation test for spatial point pattern data.
  }
  \item{fmla}{
    Plot formula used in \code{\link{plot.fv}}.
  }
  \item{\dots}{
    Additional graphical arguments passed to \code{\link{plot.fv}}.
  }
  \item{lty,col,lwd}{
    Line type, colour, and line width of the curves plotting the
    summary function for each point pattern in the original data.
    Either a single value or a
    vector of length equal to the number of point patterns.
  }
  \item{lty.theo,col.theo,lwd.theo}{
    Line type, colour, and line width of the curve representing the
    theoretical value of the summary function. 
  }
  \item{lty.mean,col.mean,lwd.mean}{
    Line type, colour, and line width (as a multiple of \code{lwd})
    of the curve representing the group mean of the summary function.
  }
  \item{separately}{
    Logical value indicating whether to plot each group of data
    in a separate panel.
  }
  \item{meanonly}{
    Logical value indicating whether to plot only the group means
    of the summary function.
  }
  \item{main}{
    Character string giving a main title for the plot.
  }
  \item{xlim,ylim}{
    Numeric vectors of length 2 giving the limits for the \eqn{x} and
    \eqn{y} coordinates of the plot or plots.
  }
  \item{ylab}{
    Character string or expression to be used for the label on the
    \eqn{y} axis.
  }
  \item{legend}{
    Logical value indicating whether to plot a legend
    explaining the meaning of each curve.
  }
  \item{legendpos}{
    Position of legend. See \code{\link{plot.fv}}.
  }
  \item{lbox}{
    Logical value indicating whether to plot a box around the plot.
  }
  \item{add}{
    Logical value indicating whether the plot should be added to
    the existing plot (\code{add=TRUE}) or whether a new frame should be
    created (\code{add=FALSE}, the default).
  }
}
\details{
  This is the \code{plot} method for objects of class
  \code{"studpermutest"} which represent the result of a studentised
  permutation test applied to several point patterns. The test is
  performed by \code{\link{studpermu.test}}.

  The plot shows the summary functions for each point pattern,
  coloured according to group.
  Optionally it can show the different groups
  in separate plot panels, or show only the group means in a single panel.
}
\value{
Null.
}
\author{
  Ute Hahn.

  Modified for \code{spatstat} by
  \spatstatAuthors.
}
\seealso{
  \code{\link{studpermu.test}}
}
\examples{
  np <- if(interactive()) 99 else 19
  testpyramidal <- studpermu.test(pyramidal, Neurons ~ group, nperm=np)
  plot(testpyramidal)
  plot(testpyramidal, meanonly=TRUE)
  plot(testpyramidal, col.theo=8, lwd.theo=4, lty.theo=1)
  plot(testpyramidal, . ~ pi * r^2)
  op <- par(mfrow=c(1,3))
  plot(testpyramidal, separately=TRUE)
  plot(testpyramidal, separately=TRUE, col=2, lty=1, lwd.mean=2, col.mean=4)
  par(op)
}
\keyword{hplot}
\keyword{htest}
\concept{Goodness-of-fit}