oceRenameMetadata

Rename an item within the <code>metadata</code> slot of an oce object.

Supports the analysis of Oceanographic data, including 'ADCP'
measurements, measurements made with 'argo' floats, 'CTD' measurements,
sectional data, sea-level time series, coastline and topographic data, etc.
Provides specialized functions for calculating seawater properties such as
potential temperature in either the 'UNESCO' or 'TEOS-10' equation of state.
Produces graphical displays that conform to the conventions of the
Oceanographic literature. This package is discussed extensively by
Kelley (2018) "Oceanographic Analysis with R" <doi:10.1007/978-1-4939-8844-0>.

Dan Kelley

Analysis of Oceanographic Data

Clark Richards

Chantelle Layton

British Geological Survey 

oceRenameMetadata function

<dl><dt>object</dt>
<dd>an oce object.</dd>
<dt>old</dt>
<dd>character value that matches the name of an item in <code>object</code>'s <code>metadata</code> slot.</dd>
<dt>new</dt>
<dd>character value to be used as the new name that matches the name of an item in
<code>object</code>'s <code>metadata</code> slot. Thus must not be the name of something that is already in the <code>metadata</code>
slot. If <code>new</code> is the same as <code>old</code>, then the object is returned unaltered.</dd>
<dt>note</dt>
<dd>character value that holds an explanation of the reason for the change. If this
is a string of non-zero length, then this is inserted in the processing log of the returned
value. If it is <code>NULL</code>, then no entry is added to the processing log. Otherwise, the processing
log gets a new item that is constructed from the function call.</dd></dl>

Arguments

Author

Rename Something in the metadata Slot of an oce Object — oceRenameMetadata

<dl>

<dt>object</dt>
<dd>an oce object.</dd>


<dt>old</dt>
<dd>character value that matches the name of an item in <code>object</code>'s <code>metadata</code> slot.</dd>


<dt>new</dt>
<dd>character value to be used as the new name that matches the name of an item in
<code>object</code>'s <code>metadata</code> slot. Thus must not be the name of something that is already in the <code>metadata</code>
slot. If <code>new</code> is the same as <code>old</code>, then the object is returned unaltered.</dd>


<dt>note</dt>
<dd>character value that holds an explanation of the reason for the change. If this
is a string of non-zero length, then this is inserted in the processing log of the returned
value. If it is <code>NULL</code>, then no entry is added to the processing log. Otherwise, the processing
log gets a new item that is constructed from the function call.</dd>

</dl>

oceRenameMetadata: Rename Something in the metadata Slot of an oce Object

Description

Usage

Arguments

Author

See Also