Windrose objects store statistical information about winds, mainly for
plotting as "wind rose" plots (see plot,windrose-method
.
There is no reading method, because there is no standard way to store
wind data in files; instead, as.windrose
is provided
to construct windrose
objects. Data elements may be retrieved
with [[,windrose-method
or replaced with
[[<-,windrose-method
. Data summaries are provided with
summary,windrose-method
.
data
As with all oce
objects, the data
slot
for windrose
objects is a
list
containing the main data for the object.
metadata
As with all oce
objects, the metadata
slot
for windrose
objects is a list
containing
information about the data
or about the object itself.
processingLog
As with all oce
objects, the processingLog
slot
for windrose
objects is a
list
with entries describing the creation and evolution
of the object. The contents are updated by various oce
functions to
keep a record of processing steps. Object summaries and
processingLogShow
both display the log.
Although the [[<-
operator may permit modification of the contents
of windrose
objects (see [[<-,windrose-method
),
it is better to use oceSetData
and oceSetMetadata
, because that will save an entry
in the processingLog
to describe the change.
The full contents of the data
and metadata
slots of a windrose
object named windrose
may be retrieved in the standard R way. For example,
slot(windrose, "data")
and slot(windrose, "metadata")
return
the data
and metadata
slots, respectively. The
[[,windrose-method
operator can also be used to access slots,
with windrose[["data"]]
and windrose[["metadata"]]
, respectively.
Furthermore, [[,windrose-method
can be used to retrieve
named items (and potentially some derived items) within the
metadata
and data
slots, the former taking precedence
over the latter in the lookup. It is also possible
to find items more directly, using oceGetData
and
oceGetMetadata
, but this cannot retrieve derived items.
Other classes provided by oce
: adp-class
,
adv-class
, argo-class
,
bremen-class
, cm-class
,
coastline-class
, ctd-class
,
lisst-class
, lobo-class
,
met-class
, oce-class
,
odf-class
, rsk-class
,
sealevel-class
,
section-class
, topo-class
Other things related to windrose
data: [[,windrose-method
,
[[<-,windrose-method
,
as.windrose
,
plot,windrose-method
,
summary,windrose-method