ODFNames2oceNames: Translate from ODF Names to Oce Names

Description

Translate data names in the ODF convention to similar names in the Oce convention.

Usage

ODFNames2oceNames(ODFnames, ODFunits = NULL, columns = NULL, PARAMETER_HEADER = NULL, debug = getOption("oceDebug"))

Arguments

ODFnames

Vector of strings holding ODF names.

ODFunits

Vector of strings holding ODF units.

columns

Optional list containing name correspondances, as described for read.ctd.odf.

PARAMETER_HEADER

Optional list containing information on the data variables.

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.

Value

A vector of strings.

Consistency warning

There are disagreements on variable names. For example, the ``DFO Common Data Dictionary'' (http://www.isdm.gc.ca/isdm-gdsi/diction/code_search-eng.asp?code=DOXY) indicates that DOXY has unit millmole/m^3 for NODC and MEDS, but has unit mL/L for BIO and IML.

Details

The following table gives the regular expressions that define recognized ODF names, along with the translated names as used in oce objects. If an item is repeated, then the second one has a 2 appended at the end, etc. Note that quality-control columns (with names starting with "QQQQ") are not handled with regular expressions. Instead, if such a flag is found in the i-th column, then a name is constructed by taking the name of the (i-1)-th column and appending "Flag".

Regexp	Result
Notes	`ALTB_.`
`altimeter`
`BATH_.`	`barometricDepth`
Barometric depth (of sensor? of water column?)	`BEAM_.`
`a`	Used in `adp` objects
`CNTR_.`	`scan`
Used in `ctd` objects	`CRAT_.`
`conductivity`	Conductivity ratio
`COND_.`	`conductivity`
Conductivity in S/m	`DEPH_.`
`pressure`	Sensor depth below sea level
`DOXY_.`	`oxygen`
Used mainly in `ctd` objects	`ERRV_.`
`error`	Used in `adp` objects
`EWCT_.`	`u`
Used in `adp` and `cm` objects	`FFFF_.`
`flag_archaic`	Old flag name, replaced by `QCFF`
`FLOR_.`	`fluorometer`
Used mainly in `ctd` objects	`FWETLABS`
`fwetlabs`	Used in ??
`HCDM`	`directionMagnetic`
	`HCDT`
`directionTrue`
`HCSP`	`speedHorizontal`
	`LATD_.`
`latitude`
`LOND_.`	`longitude`
	`NSCT_.`
`v`	Used in `adp` objects
`OCUR_.`	`oxygen`
Used mainly in `ctd` objects	`OTMP_.`
`oxygenTemperature`	Used mainly in `ctd` objects
`OXYV_.`	`oxygenVoltage`
Used mainly in `ctd` objects	`PHPH_.`
`pH`
`POTM_.`	`theta`
Used mainly in `ctd` objects	`PRES_.`
`pressure`	Used mainly in `ctd` objects
`PSAL_.`	`salinity`
Used mainly in `ctd` objects	`PSAR_.`
`par`	Used mainly in `ctd` objects
`QCFF_.`	`flag`
Overall flag	`SIGP_.`
`sigmaTheta`	Used mainly in `ctd` objecs
`SIGT_.`	`sigmat`
Used mainly in `ctd` objects	`SYTM_.`
`time`	Used in many objects
`TE90_.`	`temperature`
Used mainly in `ctd` objects	`TEMP_.`
`temperature`	Used mainly in `ctd` objects
`UNKN_.`	`-`
The result is context-dependent	`VCSP_.`
`w`	Used in `adp` objects

Any code not shown in the list is transferred to the oce object without renaming, apart from the adjustment of suffix numbers. The following code have been seen in data files from the Bedford Institute of Oceanography: ALTB, PHPH and QCFF.