File: scatterplot3d-help.tex

package info (click to toggle)
scatterplot3d 0.3-35-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 752 kB
  • ctags: 15
  • sloc: makefile: 7
file content (212 lines) | stat: -rw-r--r-- 10,085 bytes parent folder | download | duplicates (8)
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
\HeaderA{scatterplot3d}{3D Scatter Plot}{scatterplot3d}
\keyword{hplot}{scatterplot3d}
\begin{Description}\relax
Plots a three dimensional (3D) point cloud.
\end{Description}
\begin{Usage}
\begin{verbatim}
scatterplot3d(x, y=NULL, z=NULL, color=par("col"), pch=NULL,
    main=NULL, sub=NULL, xlim=NULL, ylim=NULL, zlim=NULL,
    xlab=NULL, ylab=NULL, zlab=NULL, scale.y=1, angle=40,
    axis=TRUE, tick.marks=TRUE, label.tick.marks=TRUE,
    x.ticklabs=NULL, y.ticklabs=NULL, z.ticklabs=NULL,
    y.margin.add=0, grid=TRUE, box=TRUE, lab=par("lab"),
    lab.z=mean(lab[1:2]), type=par("type"), highlight.3d=FALSE,
    mar=c(5,3,4,3)+0.1, col.axis=par("col.axis"),
    col.grid="grey", col.lab=par("col.lab"),
    cex.symbols=par("cex"), cex.axis=par("cex.axis"),
    cex.lab=0.8 * par("cex.lab"), font.axis=par("font.axis"),
    font.lab=par("font.lab"), lty.axis=par("lty"),
    lty.grid=par("lty"), lty.hide=NULL, log="", ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{x}] the coordinates of points in the plot.
\item[\code{y}] the y coordinates of points in the plot, optional if \code{x} is an appropriate structure.
\item[\code{z}] the z coordinates of points in the plot, optional if \code{x} is an appropriate structure.
\item[\code{color}] colors of points in the plot, optional if \code{x} is an appropriate structure.
Will be ignored if \code{highlight.3d = TRUE}.
\item[\code{pch}] plotting "character", i.e. symbol to use.
\item[\code{main}] an overall title for the plot.
\item[\code{sub}] sub-title.
\item[\code{xlim, ylim, zlim}] the x, y and z limits (min, max) of the plot. Note that setting enlarged limits
may not work as exactly as expected (a known but unfixed bug).
\item[\code{xlab, ylab, zlab}] titles for the x, y and z axis.
\item[\code{scale.y}] scale of y axis related to x- and z axis.
\item[\code{angle}] angle between x and y axis (Attention: result depends on
scaling.  For 180 < angle < 360  the returned functions
\code{xyz.convert} and \code{points3d} will not work properly.).
\item[\code{axis}] a logical value indicating whether axes should be drawn on the plot.
\item[\code{tick.marks}] a logical value indicating whether tick marks should
be drawn on the plot (only if \code{axis = TRUE}).
\item[\code{label.tick.marks}] a logical value indicating whether tick marks should be labeled on the plot
(only if \code{axis = TRUE} and \code{tick.marks = TRUE}).
\item[\code{x.ticklabs, y.ticklabs, z.ticklabs}] vector of tick mark labels.
\item[\code{y.margin.add}] add additional space between tick mark labels and
axis label of the y axis
\item[\code{grid}] a logical value indicating whether a grid should be drawn on the plot.
\item[\code{box}] a logical value indicating whether a box should be drawn around the plot.
\item[\code{lab}] a numerical vector of the form c(x, y, len).  The values of
x and y give the (approximate) number of tickmarks on the x and y axes.
\item[\code{lab.z}] the same as \code{lab}, but for z axis.
\item[\code{type}] character indicating the type of plot: "p" for points, "l"
for lines, "h" for vertical lines to x-y-plane, etc.
\item[\code{highlight.3d}] points will be drawn in different colors related to y coordinates
(only if \code{type = "p"} or \code{type = "h"}, else \code{color} will be used).\\
On some devices not all colors can be displayed. In this case try the
postscript device or use \code{highlight.3d = FALSE}.
\item[\code{mar}] A numerical vector of the form c(bottom, left, top, right)
which gives the lines of margin to be specified on the four sides of the plot.
\item[\code{col.axis, col.grid, col.lab}] the color to be used for axis / grid / axis labels.
\item[\code{cex.symbols, cex.axis, cex.lab}] the magnification to be used for
point symbols, axis annotation, labels relative to the current.
\item[\code{font.axis, font.lab}] the font to be used for axis annotation / labels.
\item[\code{lty.axis, lty.grid}] the line type to be used for axis / grid.
\item[\code{lty.hide}] line style used to plot \sQuote{non-visible} edges (defaults of the \code{lty.axis} style)
\item[\code{log}] Not yet implemented!  A character string which contains "x"
(if the x axis is to be logarithmic), "y", "z", "xy", "xz", "yz", "xyz".
\item[\code{...}] more graphical parameters can be given as arguments,
\code{pch = 16} or \code{pch = 20} may be nice.
\end{ldescription}
\end{Arguments}
\begin{Value}
\begin{ldescription}
\item[\code{xyz.convert}] function which converts coordinates from 3D (x, y, z)
to 2D-projection (x, y) of \code{scatterplot3d}.
Useful to plot objects into existing plot.
\item[\code{points3d}] function which draws points or lines into the existing plot.
\item[\code{plane3d}] function which draws a plane into the existing plot:
\code{plane3d(Intercept, x.coef = NULL, y.coef = NULL, lty =
      "dashed", lty.box = NULL, ...)}.
Instead of \code{Intercept} a vector containing 3
elements or an (g)lm object can be specified.
The argument \code{lty.box} allows to set a different line style for the
intersecting lines in the box's walls.
\item[\code{box3d}] function which "refreshes" the box surrounding the plot.
\end{ldescription}
\end{Value}
\begin{Note}\relax
Some graphical parameters should only be set as arguments in
\code{scatterplot3d} but not in a previous \code{\LinkA{par}{par}()} call.  One of these is
\code{mar}, which is also non-standard in another way: Users who
want to extend an existing \code{scatterplot3d} graphic with another function than
\code{points3d}, \code{plane3d} or \code{box3d}, should consider to
set \code{par(mar = c(b, l, t, r))} to the value of \code{mar} used in
\code{scatterplot3d}, which defaults to \code{c(5, 3, 4, 3) + 0.1}.

Other \code{par} arguments may be split into several arguments in
\code{scatterplot3d}, e.g., for specifying the line type.  And finally
some of \code{par} arguments do not apply here, e.g., many of those
for axis calculation.  So we recommend to try the specification of
graphical parameters at first as arguments in \code{scatterplot3d} and
only if needed as arguments in previous \code{par()} call.
\end{Note}
\begin{Author}\relax
Uwe Ligges \email{ligges@statistik.tu-dortmund.de};
\url{http://www.statistik.tu-dortmund.de/~ligges}.
\end{Author}
\begin{References}\relax
Ligges, U., and Maechler, M. (2003):
Scatterplot3d -- an R Package for Visualizing Multivariate Data.
\emph{Journal of Statistical Software} 8(11), 1--20.
\url{http://www.jstatsoft.org/}
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{persp}{persp}}, \code{\LinkA{plot}{plot}}, \code{\LinkA{par}{par}}.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
  ## On some devices not all colors can be displayed.
  ## Try the postscript device or use highlight.3d = FALSE.
  ## example 1
  z <- seq(-10, 10, 0.01)
  x <- cos(z)
  y <- sin(z)
  scatterplot3d(x, y, z, highlight.3d=TRUE, col.axis="blue",
      col.grid="lightblue", main="scatterplot3d - 1", pch=20)

  ## example 2
  temp <- seq(-pi, 0, length = 50)
  x <- c(rep(1, 50) %*% t(cos(temp)))
  y <- c(cos(temp) %*% t(sin(temp)))
  z <- c(sin(temp) %*% t(sin(temp)))
  scatterplot3d(x, y, z, highlight.3d=TRUE,
      col.axis="blue", col.grid="lightblue",
      main="scatterplot3d - 2", pch=20)

  ## example 3
  temp <- seq(-pi, 0, length = 50)
  x <- c(rep(1, 50) %*% t(cos(temp)))
  y <- c(cos(temp) %*% t(sin(temp)))
  z <- 10 * c(sin(temp) %*% t(sin(temp)))
  color <- rep("green", length(x))
  temp <- seq(-10, 10, 0.01)
  x <- c(x, cos(temp))
  y <- c(y, sin(temp))
  z <- c(z, temp)
  color <- c(color, rep("red", length(temp)))
  scatterplot3d(x, y, z, color, pch=20, zlim=c(-2, 10),
      main="scatterplot3d - 3")

  ## example 4
  my.mat <- matrix(runif(25), nrow=5)
  dimnames(my.mat) <- list(LETTERS[1:5], letters[11:15])
  my.mat # the matrix we want to plot ...

  s3d.dat <- data.frame(cols=as.vector(col(my.mat)),
      rows=as.vector(row(my.mat)),
      value=as.vector(my.mat))
  scatterplot3d(s3d.dat, type="h", lwd=5, pch=" ",
      x.ticklabs=colnames(my.mat), y.ticklabs=rownames(my.mat),
      color=grey(25:1/40), main="scatterplot3d - 4")

  ## example 5
  data(trees)
  s3d <- scatterplot3d(trees, type="h", highlight.3d=TRUE,
      angle=55, scale.y=0.7, pch=16, main="scatterplot3d - 5")
  # Now adding some points to the "scatterplot3d"
  s3d$points3d(seq(10,20,2), seq(85,60,-5), seq(60,10,-10),
      col="blue", type="h", pch=16)
  # Now adding a regression plane to the "scatterplot3d"
  attach(trees)
  my.lm <- lm(Volume ~ Girth + Height)
  s3d$plane3d(my.lm, lty.box = "solid")

  ## example 6; by Martin Maechler
  cubedraw <- function(res3d, min = 0, max = 255, cex = 2,
    text. = FALSE)
  {
    ## Purpose: Draw nice cube with corners
    cube01 <- rbind(c(0,0,1), 0, c(1,0,0),
                    c(1,1,0), 1, c(0,1,1), # < 6 outer
                    c(1,0,1), c(0,1,0))
                        # <- "inner": fore- & back-ground
    cub <- min + (max-min)* cube01
    ## visibile corners + lines:
    res3d$points3d(cub[c(1:6,1,7,3,7,5) ,],
        cex = cex, type = 'b', lty = 1)
    ## hidden corner + lines
    res3d$points3d(cub[c(2,8,4,8,6),     ],
        cex = cex, type = 'b', lty = 3)
    if(text.)## debug
        text(res3d$xyz.convert(cub), labels=1:nrow(cub),
            col='tomato', cex=2)
  }
  ## 6 a) The named colors in R, i.e. colors()
  cc <- colors()
  crgb <- t(col2rgb(cc))
  par(xpd = TRUE)
  rr <- scatterplot3d(crgb, color = cc, box = FALSE, angle = 24,
      xlim = c(-50, 300), ylim = c(-50, 300), zlim = c(-50, 300))
  cubedraw(rr)
  ## 6 b) The rainbow colors from rainbow(201)
  rbc <- rainbow(201)
  Rrb <- t(col2rgb(rbc))
  rR <- scatterplot3d(Rrb, color = rbc, box = FALSE, angle = 24,
      xlim = c(-50, 300), ylim = c(-50, 300), zlim = c(-50, 300))
  cubedraw(rR)
  rR$points3d(Rrb, col = rbc, pch = 16)
\end{ExampleCode}
\end{Examples}