File: makeDensityMatrix.Rd

package info (click to toggle)
r-cran-plotrix 3.8-4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,588 kB
  • sloc: makefile: 6
file content (71 lines) | stat: -rwxr-xr-x 3,200 bytes parent folder | download | duplicates (3)
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
\name{makeDensityMatrix}
\alias{makeDensityMatrix}
\title{Compute a matrix of counts from a list of x,y positions}
\description{
 Compute a matrix in which the counts in each cell represent the number of 
 occurrences of that cell's coordinates in a list of x,y cooordinate values,
 optionally computing a second matrix of the average of the values attached
 to the coordinate observations.
}
\usage{
 makeDensityMatrix(x,y,z=NULL,nx=100,ny=50,zfun=c("mean","sum"),
 xlim=c(-180,180),ylim=c(-90,90),geocoord=TRUE)
}
\arguments{
 \item{x,y}{Vectors of x and y coordinates. These are usually combined in a
  matrix or data frame of two columns.}
 \item{z}{Optional values attached to each coordinate pair. If these are present,
  it can be in a matrix or data frame of three columns, x, y and z.}
 \item{nx}{The number of "x" cells in the output matrix.}
 \item{ny}{The number of "y" cells in the output matrix.}
 \item{zfun}{The function to apply to the summed values attached to each 
  coordinate pair. Currently defaults to mean, otherwise the sum is returned.}
 \item{xlim}{The extreme coordinates in the horizontal direction (see Details).}
 \item{ylim}{The extreme coordinates in the vertical direction (see Details).}
 \item{geocoord}{Whether to correct the matrix values for the areal distortion
  of the Mercator projection.}
}
\details{
 \samp{makeDensityMatrix} expects two vectors or a matrix or data frame with 
 at least two columns. The function was written for geographic coordinates,
 but will also work for other numeric coordinates. An optional third vector 
 or column of values for each coordinate will be processed.
 
 Each coordinate pair adds to the count in that cell of the matrix. If there
 is a third element, that value is added to a second matrix in the same 
 position. By default, the function computes the mean of all values in each 
 cell. If \samp{zfun="sum"}, the sum of values in each cell will be returned.
 
 As geograhic data sets may be very large, leading to memory problems, 
 \samp{makeDensityMatrix} can be run on small sections of the data set and the
 resulting matrices added together as long as the coordinate limits are
 consistent throughout.
}
\value{
 Either a matrix of counts of coordinate pairs within each cell or a list of
 two such matrices, the second containing the mean or sum of values associated 
 with coordinate pairs.
}
\examples{
 x<-sample(1:20,400,TRUE)
 y<-sample(1:20,400,TRUE)
 z<-runif(400,5,20)
 xyz<-makeDensityMatrix(x,y,z,nx=20,ny=20,xlim=c(1,10),ylim=c(1,10),
  geocoord=FALSE)
 par(mar=c(7,3,2,3))
 plot(0,xlim=c(1,10),ylim=c(1,10),type="n",xlab="",axes=FALSE)
 box()
 densityGrid(xyz,range.cex=c(1,4),xlim=c(1,10),ylim=c(1,10),
  red=c(0,0.5,0.8,1),green=c(1,0.8,0.5,0),blue=0,pch=15)
 color.legend(3,-0.7,7,-0.2,c(5,10,15,20),
  rect.col=color.scale(1:4,cs1=c(0,0.5,0.8,1),cs2=c(1,0.8,0.5,0),cs3=0,alpha=1))
 par(xpd=TRUE)
 text(5,0.3,"Intensity")
 points(c(3.5,4.5,5.5,6.5),rep(-1.7,4),pch=15,cex=1:4)
 text(c(3.5,4.5,5.5,6.5),rep(-1.3,4),1:4)
 text(5,-1,"Density")
 par(xpd=FALSE)
}
\author{Jim Lemon}
\seealso{\link{densityGrid}}
\keyword{misc}