oceSetData: Set something in the 'data' slot of an 'oce' object

Description Usage Arguments Details Examples

View source: R/accessors.R

Description

Set something in the data slot of an oce object

Usage

1
oceSetData(object, name, value, unit, originalName, note = "")

Arguments

object

an oce object

name

String indicating the name of the item to be set.

value

Value for the item.

unit

An optional indication of the units for the item. This has three possible forms (see “Details”).

originalName

Optional character string giving an 'original' name (e.g. as stored in the header of a data file).

note

A note to be stored in the processing log. If an empty string (the default) then an entry will be constructed from the function call. If NULL, then no entry will be added to the processing log.

Details

There are three possibilities for unit:

Examples

1
2
3
4
5
6
7
data(ctd)
Tf <- swTFreeze(ctd)
ctd <- oceSetData(ctd, "freezing", Tf, list(unit=expression(degree*C), scale="ITS-90"))
feet <- swDepth(ctd) / 0.3048
ctd <- oceSetData(ctd, name="depthInFeet", value=feet, expression("feet"))
fathoms <- feet / 6
ctd <- oceSetData(ctd, "depthInFathoms", fathoms, "fathoms")

oce documentation built on May 29, 2017, 12:19 p.m.