<!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>Replace Parts of an rsk Object — [[&lt;-,rsk-method • 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="Replace Parts of an rsk Object — [[&lt;-,rsk-method"><meta name="description" content="The [[&amp;lt;- method works for all oce objects.
The purpose, as with the related extraction method, [[,
is to insulate users from the internal details of oce
objects, by looking for items within the various storage
slots of the object. Items not actually stored can also be
replaced, including units and data-quality
flags."><meta property="og:description" content="The [[&amp;lt;- method works for all oce objects.
The purpose, as with the related extraction method, [[,
is to insulate users from the internal details of oce
objects, by looking for items within the various storage
slots of the object. Items not actually stored can also be
replaced, including units and data-quality
flags."></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>Replace Parts of an rsk Object</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/rsk.R" class="external-link"><code>R/rsk.R</code></a></small>
      <div class="d-none name"><code>sub-subset-rsk-method.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>The <code>[[&lt;-</code> method works for all <a href="oce-class.html">oce</a> objects.
The purpose, as with the related extraction method, <code>[[</code>,
is to insulate users from the internal details of <a href="oce-class.html">oce</a>
objects, by looking for items within the various storage
slots of the object. Items not actually stored can also be
replaced, including units and data-quality
flags.</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="co"># S4 method for class 'rsk'</span></span>
<span><span class="va">x</span><span class="op">[[</span><span class="va">i</span>, <span class="va">j</span>, <span class="va">...</span><span class="op">]</span><span class="op">]</span> <span class="op">&lt;-</span> <span class="va">value</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-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
<dd><p>an <a href="rsk-class.html">rsk</a> object.</p></dd>


<dt id="arg-i">i<a class="anchor" aria-label="anchor" href="#arg-i"></a></dt>
<dd><p>character value naming the item to replace.</p></dd>


<dt id="arg-j">j<a class="anchor" aria-label="anchor" href="#arg-j"></a></dt>
<dd><p>optional additional information on the <code>i</code> item.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>optional additional information (ignored).</p></dd>


<dt id="arg-value">value<a class="anchor" aria-label="anchor" href="#arg-value"></a></dt>
<dd><p>The value to be placed into <code>x</code>, somewhere.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>As with <code>[[</code> method, the procedure works in steps.</p>
<p>First, the <code>metadata</code> slot of <code>x</code> is checked to
see whether it contains something named with <code>i</code>.
If so, then the named item is replaced with <code>value</code>.</p>
<p>Otherwise, if the string value of <code>i</code> ends in <code>Unit</code>, then the
characters preceding that are taken as the name of a variable, and
the <code>metadata</code> slot of <code>x</code> is updated to store that unit, e.g.</p>
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a>x[[<span class="st">"temperatureUnits"</span>]] <span class="ot">&lt;-</span> <span class="fu">list</span>(<span class="at">unit=</span><span class="fu">expression</span>(degree<span class="sc">*</span>F),<span class="at">scale=</span><span class="st">""</span>)</span></code></pre><p></p></div>
<p>Similarly, if <code>i</code> ends in <code>Flag</code>, then quality-control
flags are set up as defined by <code>result</code>, e.g.</p>
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a>o[[<span class="st">"temperatureFlags"</span>]] <span class="ot">&lt;-</span> <span class="fu">c</span>(<span class="dv">2</span>,<span class="dv">4</span>,<span class="dv">2</span>,<span class="dv">2</span>)</span></code></pre><p></p></div>
<p>Otherwise, <code><a href="https://rdrr.io/r/base/pmatch.html" class="external-link">pmatch()</a></code> is used for a partial-string match with
the names of the items that are in the <code>data</code> slot of <code>x</code>.
The first item found (if any) is then updated to hold the value <code>result</code>.</p>
<p>If none of these conditions is met, a warning is issued.</p>
    </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 replace parts of oce objects:
<code>[[&lt;-,adp-method</code>,
<code>[[&lt;-,amsr-method</code>,
<code>[[&lt;-,argo-method</code>,
<code>[[&lt;-,bremen-method</code>,
<code>[[&lt;-,cm-method</code>,
<code>[[&lt;-,coastline-method</code>,
<code>[[&lt;-,ctd-method</code>,
<code>[[&lt;-,echosounder-method</code>,
<code>[[&lt;-,g1sst-method</code>,
<code>[[&lt;-,gps-method</code>,
<code>[[&lt;-,ladp-method</code>,
<code>[[&lt;-,landsat-method</code>,
<code>[[&lt;-,lisst-method</code>,
<code>[[&lt;-,lobo-method</code>,
<code>[[&lt;-,met-method</code>,
<code>[[&lt;-,oce-method</code>,
<code>[[&lt;-,odf-method</code>,
<code>[[&lt;-,sealevel-method</code>,
<code>[[&lt;-,section-method</code>,
<code>[[&lt;-,tidem-method</code>,
<code>[[&lt;-,topo-method</code>,
<code>[[&lt;-,windrose-method</code>,
<code>[[&lt;-,xbt-method</code></p>
<p>Other things related to rsk data:
<code><a href="sub-sub-rsk-method.html">[[,rsk-method</a></code>,
<code><a href="as.rsk.html">as.rsk</a>()</code>,
<code><a href="ctdFindProfilesRBR.html">ctdFindProfilesRBR</a>()</code>,
<code><a href="plot-rsk-method.html">plot,rsk-method</a></code>,
<code><a href="read.rsk.html">read.rsk</a>()</code>,
<code><a href="rsk.html">rsk</a></code>,
<code><a href="rsk-class.html">rsk-class</a></code>,
<code><a href="rskPatm.html">rskPatm</a>()</code>,
<code><a href="rskToc.html">rskToc</a>()</code>,
<code><a href="subset-rsk-method.html">subset,rsk-method</a></code>,
<code><a href="summary-rsk-method.html">summary,rsk-method</a></code></p></div>
    </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>

