oceSetData: Set Something in the data Slot of an oce Object

In dankelley/oce: Analysis of Oceanographic Data

Set Something in the data Slot of an oce Object

Description

Create a copy of an object in which some element of its data slot has been altered, or added.

Usage

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

Arguments

object	an oce object.
name	the name of the data 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	character string giving an 'original' name (e.g. as stored in the header of a data file). The default, "-", is taken by summary() functions to mean that there was no original name in object.
note	either empty (the default), a character string, or NULL, to control additions made to the processing log of the return value. If note="" then the an entry is created based on deparsing the function call. If note is a non-empty string, then that string gets added added to the processing log. Finally, if note=NULL, then nothing is added to the processing log. This last form is useful in cases where oceSetData is to be called many times in succession, resulting in an overly verbose processing log; in such cases, it might help to add a note by e.g. processingLog(a) <- "QC (memo dek-2018-01/31)"

Details

The trickiest argument to set is the unit. There are three possibilities for this:

1. unit is a named or unnamed list() that contains two items. If the list is named, the names must be unit and scale. If the list is unnamed, the stated names are assigned to the items, in the stated order. Either way, the unit item must be an expression() that specifies the unit, and the scale item must be a string that describes the scale. For example, modern temperatures have unit=list(unit=expression(degree*C), scale="ITS-90").

2. unit is an expression() giving the unit as above. In this case, the scale will be set to "".

3. unit is a character string that is converted into an expression with parse(text=unit), and the scale set to "".

Value

oceSetData returns an oce object, the data slot of which has been altered either by adding a new item or modifying an existing item.

Author(s)

Dan Kelley

See Also

Other things related to the data slot: oceDeleteData(), oceGetData(), oceRenameData()

Examples

data(ctd)
Tf <- swTFreeze(ctd)
ctd <- oceSetData(ctd, "freezing", Tf,
    unit = list(unit = expression(degree * C), scale = "ITS-90")
)
plotProfile(ctd, "freezing")

dankelley/oce documentation built on March 1, 2025, 6:36 p.m.