<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Convert Argo Data Name to Oce Name — argoNames2oceNames • oce</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Convert Argo Data Name to Oce Name — argoNames2oceNames"><meta name="description" content="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)."><meta property="og:description" content="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)."></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">oce</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8-4</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/A_oce.html">1. Introduction to Oce</a></li>
    <li><a class="dropdown-item" href="../articles/B_ctd.html">2. Analysis of CTD data</a></li>
    <li><a class="dropdown-item" href="../articles/C_adp.html">3. Analysis of acoustic-Doppler data</a></li>
    <li><a class="dropdown-item" href="../articles/D_map_projections.html">4. Using map projections</a></li>
    <li><a class="dropdown-item" href="../articles/E_flags.html">5. Dealing with data-quality flags</a></li>
    <li><a class="dropdown-item" href="../articles/F_subclassing.html">6. Subclassing oce objects</a></li>
    <li><a class="dropdown-item" href="../articles/G_altering_defaults.html">7. Altering oce Defaults</a></li>
    <li><a class="dropdown-item" href="../articles/H_tides.html">8. Tidal Analysis</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/dankelley/oce/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">

      <h1>Convert Argo Data Name to Oce Name</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/argo.R" class="external-link"><code>R/argo.R</code></a></small>
      <div class="d-none name"><code>argoNames2oceNames.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>This function is used internally by <code><a href="read.argo.html">read.argo()</a></code> 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).</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">argoNames2oceNames</span><span class="op">(</span><span class="va">names</span>, ignore.case <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-names">names<a class="anchor" aria-label="anchor" href="#arg-names"></a></dt>
<dd><p>vector of character strings containing names in the Argo convention.</p></dd>


<dt id="arg-ignore-case">ignore.case<a class="anchor" aria-label="anchor" href="#arg-ignore-case"></a></dt>
<dd><p>a logical value passed to <code><a href="https://rdrr.io/r/base/grep.html" class="external-link">gsub()</a></code>, indicating whether to
ignore the case of input strings. The default is set to <code>TRUE</code> because some data
files use lower-case names, despite the fact that the Argo documentation specifies
upper-case.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A character vector of the same length as <code>names</code>, but with
replacements having been made for all known quantities.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>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: <code>VRSpH</code> was renamed
<code>phSensorVoltageDifference</code>, to match related names that had been added.</p>
<p>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.</p>
<p>The names are converted with
<code><a href="https://rdrr.io/r/base/grep.html" class="external-link">gsub()</a></code>, using the <code>ignore.case</code> 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
<code>_ADJUSTED</code>, <code>_ERROR</code> and <code>_QC</code>,
are translated to <code>Adjusted</code>, <code>Error</code>, and <code>QC</code>, respectively.</p>
<p>An incomplete list of name translations is as follows, where <code>~</code>
represents digit sequences in some instances and letters
in others.  Note that until June 2023, <code>pHSensorVoltageDifference</code>
was called <code>VRSpH</code>.</p>
<table class="table table"><tr><td><strong>Argo name</strong></td><td><strong>oce name</strong></td></tr><tr><td><code>BBP</code></td><td><code>bbp</code></td></tr><tr><td><code>BETA_BACKSCATTERING</code></td><td><code>betaBackscattering</code></td></tr><tr><td><code>BPHASE_OXY</code></td><td><code>bphaseOxygen</code></td></tr><tr><td><code>C~PHASE_DOXY</code></td><td><code>C~phaseOxygen</code></td></tr><tr><td><code>CDOM</code></td><td><code>CDOM</code></td></tr><tr><td><code>CNDC</code></td><td><code>conductivity</code></td></tr><tr><td><code>CHLA</code></td><td><code>chlorophyllA</code></td></tr><tr><td><code>CP</code></td><td><code>beamAttenuation</code></td></tr><tr><td><code>CYCLE_NUMBER</code></td><td><code>cycleNumber</code> (both this and <code>cycle</code> are handled by the [[ operator)</td></tr><tr><td><code>DATA_CENTRE</code></td><td><code>dataCentre</code></td></tr><tr><td><code>DATA_MODE</code></td><td><code>dataMode</code></td></tr><tr><td><code>DATA_STATE_INDICATOR</code></td><td><code>dataStateIndicator</code></td></tr><tr><td><code>DC_REFERENCE</code></td><td><code>DCReference</code></td></tr><tr><td><code>DIRECTION</code></td><td><code>direction</code></td></tr><tr><td><code>DOWN_IRRADIANCE</code></td><td><code>downwellingIrradiance</code></td></tr><tr><td><code>DOWNWELLING_PAR</code></td><td><code>downwellingPAR</code></td></tr><tr><td><code>FIRMWARE_VERSION</code></td><td><code>firmwareVersion</code></td></tr><tr><td><code>FIT_ERROR_NITRATE</code></td><td><code>fitErrorNitrate</code></td></tr><tr><td><code>FLUORESCENCE_CDOM</code></td><td><code>fluorescenceCDOM</code></td></tr><tr><td><code>FLUORESCENCE_CHLA</code></td><td><code>fluorescenceChlorophyllA</code></td></tr><tr><td><code>IB_PH</code></td><td><code>pHBaseCurrent</code></td></tr><tr><td><code>IK_PH</code></td><td><code>pHCounterCurrent</code></td></tr><tr><td><code>INST_REFERENCE</code></td><td><code>instReference</code></td></tr><tr><td><code>JULD</code></td><td><code>juld</code> (and used to compute <code>time</code>)</td></tr><tr><td><code>JULD_QC_LOCATION</code></td><td><code>juldQCLocation</code></td></tr><tr><td><code>LATITUDE</code></td><td><code>latitude</code></td></tr><tr><td><code>LONGITUDE</code></td><td><code>longitude</code></td></tr><tr><td><code>MOLAR_DOXY</code></td><td><code>oxygenUncompensated</code></td></tr><tr><td><code>MTIME</code></td><td><code>mtime</code></td></tr><tr><td><code>NB_SAMPLE_CTD</code></td><td><code>nbSampleCtd</code></td></tr><tr><td><code>PH_IN_SITU_FREE</code></td><td><code>pHFree</code></td></tr><tr><td><code>PH_IN_SITU_TOTAL</code></td><td><code>pH</code></td></tr><tr><td><code>PI_NAME</code></td><td><code>PIName</code></td></tr><tr><td><code>PLATFORM_NUMBER</code></td><td><code>id</code></td></tr><tr><td><code>POSITION_ACCURACY</code></td><td><code>positionAccuracy</code></td></tr><tr><td><code>POSITIONING_SYSTEM</code></td><td><code>positioningSystem</code></td></tr><tr><td><code>PROFILE</code></td><td><code>profile</code></td></tr><tr><td><code>PROJECT_NAME</code></td><td><code>projectName</code></td></tr><tr><td><code>RAW_DOWNWELLING_IRRADIANCE</code></td><td><code>rawDownwellingIrradiance</code></td></tr><tr><td><code>RAW_DOWNWELLING_PAR</code></td><td><code>rawDownwellingPAR</code></td></tr><tr><td><code>RAW_UPWELLING_RADIANCE</code></td><td><code>rawUpwellingRadiance</code></td></tr><tr><td><code>STATION_PARAMETERS</code></td><td><code>stationParameters</code></td></tr><tr><td><code>TEMP</code></td><td><code>temperature</code></td></tr><tr><td><code>TEMP_CPU_CHLA</code></td><td><code>temperatureCPUChlorophyllA</code></td></tr><tr><td><code>TEMP_DOXY</code></td><td><code>temperatureOxygen</code></td></tr><tr><td><code>TEMP_NITRATE</code></td><td><code>temperatureNitrate</code></td></tr><tr><td><code>TEMP_PH</code></td><td><code>temperaturePH</code></td></tr><tr><td><code>TEMP_SPECTROPHOTOMETER_NITRATE</code></td><td><code>temperatureSpectrophotometerNitrate</code></td></tr><tr><td><code>TILT</code></td><td><code>tilt</code></td></tr><tr><td><code>TPHASE_DOXY</code></td><td><code>tphaseOxygen</code></td></tr><tr><td><code>TURBIDITY</code></td><td><code>turbidity</code></td></tr><tr><td><code>UP_RADIANCE</code></td><td><code>upwellingRadiance</code></td></tr><tr><td><code>UV_INTENSITY</code></td><td><code>UVIntensity</code></td></tr><tr><td><code>UV_INTENSITY_DARK_NITRATE</code></td><td><code>UVIntensityDarkNitrate</code></td></tr><tr><td><code>UV_INTENSITY_NITRATE</code></td><td><code>UVIntensityNitrate</code></td></tr><tr><td><code>VRS_PH</code></td><td><code>pHSensorVoltageDifference</code></td></tr><tr><td><code>WMO_INST_TYPE</code></td><td><code>WMOInstType</code></td></tr></table></div>
    <div class="section level2">
    <h2 id="references">References<a class="anchor" aria-label="anchor" href="#references"></a></h2>

<ol><li><p>Argo User's Manual Version 3.3, Nov 89th, 2019, available at
<code>https://archimer.ifremer.fr/doc/00187/29825/</code> online.</p></li>
<li><p>Argo list of parameters in an excel spreadsheet, available at
<code>http://www.argodatamgt.org/content/download/27444/187206/file/argo-parameters-list-core-and-b.xlsx</code></p></li>
</ol></div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p>Other functions that convert variable names to the oce convention:
<code><a href="ODFNames2oceNames.html">ODFNames2oceNames</a>()</code>,
<code><a href="bodcNames2oceNames.html">bodcNames2oceNames</a>()</code>,
<code><a href="metNames2oceNames.html">metNames2oceNames</a>()</code>,
<code><a href="woceNames2oceNames.html">woceNames2oceNames</a>()</code></p>
<p>Other things related to argo data:
<code><a href="sub-sub-argo-method.html">[[,argo-method</a></code>,
<code>[[&lt;-,argo-method</code>,
<code><a href="argo.html">argo</a></code>,
<code><a href="argo-class.html">argo-class</a></code>,
<code><a href="argoGrid.html">argoGrid</a>()</code>,
<code><a href="as.argo.html">as.argo</a>()</code>,
<code><a href="handleFlags-argo-method.html">handleFlags,argo-method</a></code>,
<code><a href="plot-argo-method.html">plot,argo-method</a></code>,
<code><a href="read.argo.html">read.argo</a>()</code>,
<code><a href="read.argo.copernicus.html">read.argo.copernicus</a>()</code>,
<code><a href="subset-argo-method.html">subset,argo-method</a></code>,
<code><a href="summary-argo-method.html">summary,argo-method</a></code></p></div>
    </div>
    <div class="section level2">
    <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
    <p>Dan Kelley, with help from Anna Victor</p>
    </div>

  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Dan Kelley, Clark Richards.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.9000.</p>
</div>

    </footer></div>





  </body></html>

