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

In oce: Analysis of Oceanographic Data

Rename Something in the metadata Slot of an oce Object

Description

Rename an item within the metadata slot of an oce object.

Usage

oceRenameMetadata(object, old, new, note = "")

Arguments

object	an oce object.
old	character value that matches the name of an item in object's metadata slot.
new	character value to be used as the new name that matches the name of an item in object's metadata slot. Thus must not be the name of something that is already in the metadata slot. If new is the same as old, then the object is returned unaltered.
note	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 NULL, then no entry is added to the processing log. Otherwise, the processing log gets a new item that is constructed from the function call.

Author(s)

Dan Kelley

See Also

Other things related to the metadata slot: oceDeleteMetadata(), oceGetMetadata(), oceSetMetadata()

oce documentation built on Sept. 11, 2024, 7:09 p.m.