File: pairsVIM.Rd

package info (click to toggle)
r-cran-vim 6.2.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,556 kB
  • sloc: cpp: 141; sh: 12; makefile: 2
file content (122 lines) | stat: -rw-r--r-- 3,804 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
119
120
121
122
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pairsVIM.R
\name{pairsVIM}
\alias{pairsVIM}
\title{Scatterplot Matrices}
\usage{
pairsVIM(
  x,
  ...,
  delimiter = NULL,
  main = NULL,
  sub = NULL,
  panel = points,
  lower = panel,
  upper = panel,
  diagonal = NULL,
  labels = TRUE,
  pos.labels = NULL,
  cex.labels = NULL,
  font.labels = par("font"),
  layout = c("matrix", "graph"),
  gap = 1
)
}
\arguments{
\item{x}{a matrix or \code{data.frame}.}

\item{\dots}{further arguments and graphical parameters to be passed down.
\code{par("oma")} will be set appropriately unless supplied (see
\code{\link[graphics:par]{graphics::par()}}).}

\item{delimiter}{a character-vector to distinguish between variables and
imputation-indices for imputed variables (therefore, \code{x} needs to have
\code{\link[=colnames]{colnames()}}). If given, it is used to determine the corresponding
imputation-index for any imputed variable (a logical-vector indicating which
values of the variable have been imputed). If such imputation-indices are
found, they are used for highlighting and the colors are adjusted according
to the given colors for imputed variables (see \code{col}).}

\item{main, sub}{main and sub title.}

\item{panel}{a \code{function(x, y, \dots{})}, which is used to plot the
contents of each off-diagonal panel of the display.}

\item{lower, upper}{separate panel functions to be used below and above the
diagonal, respectively.}

\item{diagonal}{optional \code{function(x, \dots{})} to be applied on the
diagonal panels.}

\item{labels}{either a logical indicating whether labels should be plotted
in the diagonal panels, or a character vector giving the labels.}

\item{pos.labels}{the vertical position of the labels in the diagonal
panels.}

\item{cex.labels}{the character expansion factor to be used for the labels.}

\item{font.labels}{the font to be used for the labels.}

\item{layout}{a character string giving the layout of the scatterplot
matrix.  Possible values are \code{"matrix"} (a matrix-like layout with the
first row on top) and \code{"graph"} (a graph-like layout with the first row
at the bottom).}

\item{gap}{a numeric value giving the distance between the panels in margin
lines.}
}
\description{
Create a scatterplot matrix.
}
\details{
This function is the workhorse for \code{\link[=marginmatrix]{marginmatrix()}} and
\code{\link[=scattmatrixMiss]{scattmatrixMiss()}}.

The graphical parameter \code{oma} will be set unless supplied as an
argument.

A panel function should not attempt to start a new plot, since the
coordinate system for each panel is set up by \code{pairsVIM}.
}
\note{
The code is based on \code{\link[graphics:pairs]{graphics::pairs()}}.  Starting with
version 1.4, infinite values are no longer removed before passing the
\code{x} and \code{y} vectors to the panel functions.
}
\examples{

data(sleep, package = "VIM")
x <- sleep[, -(8:10)]
x[,c(1,2,4,6,7)] <- log10(x[,c(1,2,4,6,7)])
pairsVIM(x)

}
\references{
M. Templ, A. Alfons, P. Filzmoser (2012) Exploring incomplete
data using visualization tools.  \emph{Journal of Advances in Data Analysis
and Classification}, Online first. DOI: 10.1007/s11634-011-0102-y.
}
\seealso{
\code{\link[=marginmatrix]{marginmatrix()}}, \code{\link[=scattmatrixMiss]{scattmatrixMiss()}}

Other plotting functions: 
\code{\link{aggr}()},
\code{\link{barMiss}()},
\code{\link{histMiss}()},
\code{\link{marginmatrix}()},
\code{\link{marginplot}()},
\code{\link{matrixplot}()},
\code{\link{mosaicMiss}()},
\code{\link{parcoordMiss}()},
\code{\link{pbox}()},
\code{\link{scattJitt}()},
\code{\link{scattMiss}()},
\code{\link{scattmatrixMiss}()},
\code{\link{spineMiss}()}
}
\author{
Andreas Alfons, modifications by Bernd Prantner
}
\concept{plotting functions}
\keyword{hplot}