Learn R Programming

oce (version 1.8-3)

argoNames2oceNames: Convert Argo Data Name to Oce Name

Description

This function is used internally by read.argo() to convert Argo-convention data names to oce-convention names. Users should not call this directly, since its return value may be changed at any moment (e.g. to include units as well as names).

Usage

argoNames2oceNames(names, ignore.case = TRUE)

Value

A character vector of the same length as names, but with replacements having been made for all known quantities.

Arguments

names

vector of character strings containing names in the Argo convention.

ignore.case

a logical value passed to gsub(), indicating whether to ignore the case of input strings. The default is set to TRUE because some data files use lower-case names, despite the fact that the Argo documentation specifies upper-case.

Author

Dan Kelley, with help from Anna Victor

Details

Initially, Feb 2016, the inference of names was initially done by an inspection of some data files, based on reference 1. Later, in June 2023, broader inspection of more files and documents yielded about ten additions, and a single correction: VRSpH was renamed phSensorVoltageDifference, to match related names that had been added.

It should be noted that the data files examined contain some names that are not documented in reference 1, and others that are listed only in its changelog, with no actual definitions being given. For example, the files had six distinct variable names that seem to relate to phase in the oxygen sensor, but these are not translated by the present function because these variable names are not defined in reference 1, or not defined uniquely in reference 2.

The names are converted with gsub(), using the ignore.case argument of the present function. The procedure is to first handle the items listed in the following table, with string searches anchored to the start of the string. After that, the qualifiers _ADJUSTED, _ERROR and _QC, are translated to Adjusted, Error, and QC, respectively.

An incomplete list of name translations is as follows, where ~ represents digit sequences in some instances and letters in others. Note that until June 2023, pHSensorVoltageDifference was called VRSpH.

Argo nameoce name
BBPbbp
BETA_BACKSCATTERINGbetaBackscattering
BPHASE_OXYbphaseOxygen
C~PHASE_DOXYC~phaseOxygen
CDOMCDOM
CNDCconductivity
CHLAchlorophyllA
CPbeamAttenuation
CYCLE_NUMBERcycleNumber (both this and cycle are handled by the [[ operator)
DATA_CENTREdataCentre
DATA_MODEdataMode
DATA_STATE_INDICATORdataStateIndicator
DC_REFERENCEDCReference
DIRECTIONdirection
DOWN_IRRADIANCEdownwellingIrradiance
DOWNWELLING_PARdownwellingPAR
FIRMWARE_VERSIONfirmwareVersion
FIT_ERROR_NITRATEfitErrorNitrate
FLUORESCENCE_CDOMfluorescenceCDOM
FLUORESCENCE_CHLAfluorescenceChlorophyllA
IB_PHpHBaseCurrent
IK_PHpHCounterCurrent
INST_REFERENCEinstReference
JULDjuld (and used to compute time)
JULD_QC_LOCATIONjuldQCLocation
LATITUDElatitude
LONGITUDElongitude
MOLAR_DOXYoxygenUncompensated
MTIMEmtime
NB_SAMPLE_CTDnbSampleCtd
PH_IN_SITU_FREEpHFree
PH_IN_SITU_TOTALpH
PI_NAMEPIName
PLATFORM_NUMBERid
POSITION_ACCURACYpositionAccuracy
POSITIONING_SYSTEMpositioningSystem
PROFILEprofile
PROJECT_NAMEprojectName
RAW_DOWNWELLING_IRRADIANCErawDownwellingIrradiance
RAW_DOWNWELLING_PARrawDownwellingPAR
RAW_UPWELLING_RADIANCErawUpwellingRadiance
STATION_PARAMETERSstationParameters
TEMPtemperature
TEMP_CPU_CHLAtemperatureCPUChlorophyllA
TEMP_DOXYtemperatureOxygen
TEMP_NITRATEtemperatureNitrate
TEMP_PHtemperaturePH
TEMP_SPECTROPHOTOMETER_NITRATEtemperatureSpectrophotometerNitrate
TILTtilt
TPHASE_DOXYtphaseOxygen
TURBIDITYturbidity
UP_RADIANCEupwellingRadiance
UV_INTENSITYUVIntensity
UV_INTENSITY_DARK_NITRATEUVIntensityDarkNitrate
UV_INTENSITY_NITRATEUVIntensityNitrate
VRS_PHpHSensorVoltageDifference
WMO_INST_TYPEWMOInstType

References

  1. Argo User's Manual Version 3.3, Nov 89th, 2019, available at https://archimer.ifremer.fr/doc/00187/29825/ online.

  2. Argo list of parameters in an excel spreadsheet, available at http://www.argodatamgt.org/content/download/27444/187206/file/argo-parameters-list-core-and-b.xlsx

See Also

Other things related to argo data: [[,argo-method, [[<-,argo-method, argo, argo-class, argoGrid(), as.argo(), handleFlags,argo-method, plot,argo-method, read.argo(), read.argo.copernicus(), subset,argo-method, summary,argo-method