File: bin.wind.records.Rd

package info (click to toggle)
r-cran-plotrix 3.2-6-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,136 kB
  • sloc: makefile: 3
file content (35 lines) | stat: -rwxr-xr-x 1,254 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
\name{bin.wind.records}
\alias{bin.wind.records}
\title{Classify wind direction and speed records}
\description{Classifies wind direction and speed records into a matrix of
 percentages of observations in speed and direction bins.}
\usage{
 bin.wind.records(winddir,windspeed,ndir=8,radians=FALSE,
  speed.breaks=c(0,10,20,30))
}
\arguments{
 \item{winddir}{A vector of wind directions.}
 \item{windspeed}{A vector of wind speeds corresponding to the above
  directions.}
 \item{ndir}{Number of direction bins in a compass circle.}
 \item{radians}{Whether wind directions are in radians.}
 \item{speed.breaks}{Minimum wind speed for each speed bin.}
}
\details{
 \samp{bin.wind.records} bins a number of wind direction and speed
  records into a matrix of percentages of observations that can be used to
  display a cumulative wind rose with \samp{oz.windrose} The defaults are those
  used by the Australian Bureau of Meteorology.
}
\value{
 A matrix of percentages in which the rows represent wind speed categories and 
 the columns represent wind direction categories.
}
\author{Jim Lemon}
\seealso{\link{oz.windrose}}
\examples{
 winddir<-sample(0:360,100,TRUE)
 windspeed<-sample(0:40,100,TRUE)
 bin.wind.records(winddir,windspeed)
}
\keyword{misc}