File: growdotMiss.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 (154 lines) | stat: -rw-r--r-- 5,564 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/growdotMiss.R
\name{growdotMiss}
\alias{growdotMiss}
\alias{bubbleMiss}
\title{Growing dot map with information about missing/imputed values}
\usage{
growdotMiss(
  x,
  coords,
  map,
  pos = 1,
  delimiter = NULL,
  selection = c("any", "all"),
  log = FALSE,
  col = c("skyblue", "red", "skyblue4", "red4", "orange", "orange4"),
  border = par("bg"),
  alpha = NULL,
  scale = NULL,
  size = NULL,
  exp = c(0, 0.95, 0.05),
  col.map = grey(0.5),
  legend = TRUE,
  legtitle = "Legend",
  cex.legtitle = par("cex"),
  cex.legtext = par("cex"),
  ncircles = 6,
  ndigits = 1,
  interactive = TRUE,
  ...
)
}
\arguments{
\item{x}{a vector, matrix or \code{data.frame}.}

\item{coords}{a matrix or \code{data.frame} with two columns giving the
spatial coordinates of the observations.}

\item{map}{a background map to be passed to \code{\link[=bgmap]{bgmap()}}.}

\item{pos}{a numeric value giving the index of the variable determining the
dot sizes.}

\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{selection}{the selection method for highlighting missing/imputed
values in multiple additional variables.  Possible values are \code{"any"}
(highlighting of missing/imputed values in \emph{any} of the additional
variables) and \code{"all"} (highlighting of missing/imputed values in
\emph{all} of the additional variables).}

\item{log}{a logical indicating whether the variable given by \code{pos}
should be log-transformed.}

\item{col}{a vector of length six giving the colors to be used in the plot.
If only one color is supplied, it is used for the borders of non-highlighted
dots and the surface area of highlighted dots.  Else if two colors are
supplied, they are recycled.}

\item{border}{a vector of length four giving the colors to be used for the
borders of the growing dots.  Use \code{NA} to omit borders.}

\item{alpha}{a numeric value between 0 and 1 giving the level of
transparency of the colors, or \code{NULL}.  This can be used to prevent
overplotting.}

\item{scale}{scaling factor of the map.}

\item{size}{a vector of length two giving the sizes for the smallest and
largest dots.}

\item{exp}{a vector of length three giving the factors that define the shape
of the exponential function (see \sQuote{Details}).}

\item{col.map}{the color to be used for the background map.}

\item{legend}{a logical indicating whether a legend should be plotted.}

\item{legtitle}{the title for the legend.}

\item{cex.legtitle}{the character expansion factor to be used for the title
of the legend.}

\item{cex.legtext}{the character expansion factor to be used in the legend.}

\item{ncircles}{the number of circles displayed in the legend.}

\item{ndigits}{the number of digits displayed in the legend.  Note that \
this is just a suggestion (see \code{\link[=format]{format()}}).}

\item{interactive}{a logical indicating whether information about certain
observations can be displayed interactively (see \sQuote{Details}).}

\item{\dots}{for \code{growdotMiss}, further arguments and graphical
parameters to be passed to \code{\link[=bgmap]{bgmap()}}.  For \code{bubbleMiss}, the
arguments to be passed to \code{growdotMiss}.}
}
\description{
Map with dots whose sizes correspond to the values in a certain variable.
Observations with missing/imputed values in additional variables are
highlighted.
}
\details{
The smallest dots correspond to the 10\\% quantile and the largest dots to
the 99\\% quantile.  In between, the dots grow exponentially, with \code{exp}
defining the shape of the exponential function.  Missings/imputed missings
in the variable of interest will be drawn as rectangles.

If \code{interactive=TRUE}, detailed information for an observation can be
printed on the console by clicking on the corresponding point.  Clicking in
a region that does not contain any points quits the interactive session.
}
\note{
The function was renamed to \code{growdotMiss} in version 1.3.
\code{bubbleMiss} is a (deprecated) wrapper for \code{growdotMiss} for back
compatibility with older versions. However, due to extended functionality,
some of the argument positions have changed.

The code is based on (removed from CRAN) bubbleFIN from package
StatDA.
}
\examples{

data(chorizonDL, package = "VIM")
data(kola.background, package = "VIM")
coo <- chorizonDL[, c("XCOO", "YCOO")]
## for missing values
x <- chorizonDL[, c("Ca","As", "Bi")]
growdotMiss(x, coo, kola.background, border = "white")

## for imputed values
x_imp <- kNN(chorizonDL[,c("Ca","As","Bi" )])
growdotMiss(x_imp, coo, kola.background, delimiter = "_imp", border = "white")

}
\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[=bgmap]{bgmap()}}, \code{\link[=mapMiss]{mapMiss()}},
\code{\link[=colormapMiss]{colormapMiss()}}
}
\author{
Andreas Alfons, Matthias Templ, Peter Filzmoser, Bernd Prantner
}
\keyword{hplot}