]> git.donarmstrong.com Git - ape.git/blob - man/plot.correlogram.Rd
various corrections
[ape.git] / man / plot.correlogram.Rd
1 \name{plot.correlogram}
2 \alias{plot.correlogram}
3 \alias{plot.correlogramList}
4 \title{Plot a Correlogram}
5 \usage{
6   \method{plot}{correlogram}(x, legend = TRUE, test.level = 0.05,
7                 col = c("grey", "red"), type = "b", xlab = "",
8                 ylab = "Moran's I", pch = 21, cex = 2, ...)
9   \method{plot}{correlogramList}(x, lattice = TRUE, legend = TRUE,
10                 test.level = 0.05, col = c("grey", "red"),
11                 xlab = "", ylab = "Moran's I",
12                 type = "b", pch = 21, cex = 2, ...)
13 }
14 \arguments{
15   \item{x}{an object of class \code{"correlogram"} or of class
16     \code{"correlogramList"} (both produced by
17     \code{\link{correlogram.formula}}).}
18   \item{legend}{should a legend be added on the plot?}
19   \item{test.level}{the level used to discriminate the plotting symbols
20     with colours considering the P-values.}
21   \item{col}{two colours for the plotting symbols: the first one is used
22     if the P-value is greater than or equal to \code{test.level}, the
23     second one otherwise.}
24   \item{type}{the type of plot to produce (see
25     \code{\link[graphics]{plot}} for possible choices).}
26   \item{xlab}{an optional character string for the label on the x-axis
27     (none by default).}
28   \item{ylab}{the default label on the y-axis.}
29   \item{pch}{the type of plotting symbol.}
30   \item{cex}{the default size for the plotting symbols.}
31   \item{lattice}{when plotting several correlograms, should they be
32     plotted in trellis-style with lattice (the default), or together on
33     the same plot?}
34   \item{\dots}{other parameters passed to the \code{plot} or \code{lines}
35     function.}
36 }
37 \description{
38   These functions plot correlagrams previously computed with
39   \code{\link{correlogram.formula}}.
40 }
41 \details{
42   When plotting several correlograms with lattice, some options have no
43   effect: \code{legend}, \code{type}, and \code{pch} (\code{pch=19} is
44   always used in this situation).
45
46   When using \code{pch} between 1 and 20 (i.e., non-filled symbols, the
47   colours specified in \code{col} are also used for the lines joining
48   the points. To keep black lines, it is better to leave \code{pch}
49   between 21 and 25.
50 }
51 \author{Emmanuel Paradis}
52 \seealso{
53   \code{\link{correlogram.formula}}, \code{\link{Moran.I}}
54 }
55 \keyword{hplot}