ctdAddColumn: Add a Column to the Data Slot of a CTD Object [deprecated]

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/ctd.R

Description

WARNING: This function will be removed soon; see oce-deprecated. Use oceSetData instead of the present function.

Usage

1
2
ctdAddColumn(x, column, name, label, unit = NULL, log = TRUE,
  originalName = "", debug = getOption("oceDebug"))

Arguments

x

A ctd object, i.e. one inheriting from ctd-class.

column

A column of data to be inserted, in the form of a numeric vector, whose length matches that of columns in the objecct.

name

Character string indicating the name this column is to have in the data slot of x.

label

Optional character string or expression indicating the name of the column, as it will appear in plot labels. (If not given, name will be used.)

unit

Optional indication of the unit, in the form of a list containing items unit, which is an expression, and scale, which is a character string. For example, modern measurements of temperature have unit list(name=expression(degree*C), scale="ITS-90").

log

A logical value indicating whether to store an entry in the processing log that indicates this insertion.

originalName

string indicating the name of the data element as it was originally. This makes sense only for data being read from a file, where e.g. WOCE or SBE names might be used.

debug

an integer specifying whether debugging information is to be printed during the processing. This is a general parameter that is used by many oce functions. Generally, setting debug=0 turns off the printing, while higher values suggest that more information be printed. If one function calls another, it usually reduces the value of debug first, so that a user can often obtain deeper debugging by specifying higher debug values.

Details

Add a column to the data slot of an object of ctd-class, also updating the metadata slot as appropriate.

Value

A ctd object.

Author(s)

Dan Kelley

See Also

The documentation for ctd-class explains the structure of CTD objects, and also outlines the other functions dealing with them.

Other functions that will be removed soon: addColumn, ctdUpdateHeader, mapMeridians, mapZones, oce.as.POSIXlt

Examples

1
2
3
4
5
library(oce)
data(ctd)
F <- 32 + (9/5)*ctd[["temperature"]]
ctdNew <- ctdAddColumn(ctd, F, "temperatureF",
    unit=list(unit=expression(degree*F), scale="ITS-90"))

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

Search within the oce package
Search all R packages, documentation and source code