as.windrose {oce}R Documentation

Create a windrose object

Description

Create a wind-rose object, typically for plotting with plot.windrose().

Usage

as.windrose(x, y, dtheta = 15)

Arguments

x the x component of wind speed (or stress).
y the y component of wind speed (or stress).
dtheta the angle increment (in degrees) within which to classify the data

Details

This is analagous to a histogram, but with breaks being angles.

Value

An object of class "windrose", which is a list containing the following items

data a list containing
n
the number of x values
x.mean
the mean of the x values
y.mean
the mean of the y values
theta
the central angle (in degrees) for the class
count
the number of observations in this class
mean
the mean of the observations in this class
fivenum
the fivenum vector for observations in this class (the min, the lower hinge, the median, the upper hinge, and the max)
metadata a list containing dtheta, the size of the angle category, in degrees
processing.log a processing log, in the standard oce format.

Author(s)

Dan Kelley

See Also

Use plot.windrose to produce a summary plot, and summary.windrose to produce a numerical summary.

Examples

library(oce)
xcomp <- rnorm(360) + 1
ycomp <- rnorm(360)
wr <- as.windrose(xcomp, ycomp)
summary(wr)
plot(wr)

[Package oce version 0.1-76 Index]