summary.windrose {oce}R Documentation

Summarize a windrose data object

Description

Summarizes some of the data in a windrose object.

Usage

## S3 method for class 'windrose':
summary(object, ...)

## S3 method for class 'summary.windrose':
print(x, digits=max(6, getOption("digits")-1), ...)

Arguments

object an object of class "windrose", usually, a result of a call to as.windrose.
x an object of class "summary.windrose", usually, a result of a call to summary.windrose.
digits the number of significant digits to use when printing.
... further arguments passed to or from other methods.

Details

Pertinent summary information is presented.

Value

An object of class "summary.windrose", which contains pertinent information about the windrose record and its processing.

Author(s)

Dan Kelley

See Also

A windrose object may be created with as.windrose or plotted with plot.windrose.

Examples

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

[Package oce version 0.1-80 Index]