<!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>Sort a Section — sectionSort • 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="Sort a Section — sectionSort"><meta name="description" content='Sections created with as.section() have "stations" that are in the
order of the CTD objects (or filenames for such objects) provided.  Sometimes,
this is not the desired order, e.g. if file names discovered with
dir() are in an order that makes no sense.  (For example, a
practioner might name stations "stn1", "stn2", etc., not
realizing that this will yield an unhelpful ordering, by file name, if there
are more than 9 stations.) The purpose of sectionSort is to permit
reordering the constituent stations in sensible ways.'><meta property="og:description" content='Sections created with as.section() have "stations" that are in the
order of the CTD objects (or filenames for such objects) provided.  Sometimes,
this is not the desired order, e.g. if file names discovered with
dir() are in an order that makes no sense.  (For example, a
practioner might name stations "stn1", "stn2", etc., not
realizing that this will yield an unhelpful ordering, by file name, if there
are more than 9 stations.) The purpose of sectionSort is to permit
reordering the constituent stations in sensible ways.'></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>Sort a Section</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/section.R" class="external-link"><code>R/section.R</code></a></small>
      <div class="d-none name"><code>sectionSort.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Sections created with <code><a href="as.section.html">as.section()</a></code> have "stations" that are in the
order of the CTD objects (or filenames for such objects) provided.  Sometimes,
this is not the desired order, e.g. if file names discovered with
<code><a href="https://rdrr.io/r/base/list.files.html" class="external-link">dir()</a></code> are in an order that makes no sense.  (For example, a
practioner might name stations <code>"stn1"</code>, <code>"stn2"</code>, etc., not
realizing that this will yield an unhelpful ordering, by file name, if there
are more than 9 stations.) The purpose of <code>sectionSort</code> is to permit
reordering the constituent stations in sensible ways.</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">sectionSort</span><span class="op">(</span><span class="va">section</span>, <span class="va">by</span>, decreasing <span class="op">=</span> <span class="cn">FALSE</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-section">section<a class="anchor" aria-label="anchor" href="#arg-section"></a></dt>
<dd><p>A <code>section</code> object containing the section whose stations
are to be sorted.</p></dd>


<dt id="arg-by">by<a class="anchor" aria-label="anchor" href="#arg-by"></a></dt>
<dd><p>An optional string indicating how to reorder.  If not provided,
<code>"stationID"</code> will be assumed.  Other choices are <code>"distance"</code>, for
distance from the first station, <code>"longitude"</code>, for longitude,
<code>"latitude"</code> for latitude, and <code>"time"</code>, for time.</p></dd>


<dt id="arg-decreasing">decreasing<a class="anchor" aria-label="anchor" href="#arg-decreasing"></a></dt>
<dd><p>A logical value indicating whether to sort in decreasing
order.  The default is FALSE. (Thanks to Martin Renner for adding this
parameter.)</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>object A <a href="section-class.html">section</a> object that has been smoothed,
so its data fields will station-to-station variation than
is the case for the input section, <code>x</code>.</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 things related to section data:
<code><a href="sub-sub-section-method.html">[[,section-method</a></code>,
<code>[[&lt;-,section-method</code>,
<code><a href="as.section.html">as.section</a>()</code>,
<code><a href="handleFlags-section-method.html">handleFlags,section-method</a></code>,
<code><a href="initializeFlagScheme-section-method.html">initializeFlagScheme,section-method</a></code>,
<code><a href="plot-section-method.html">plot,section-method</a></code>,
<code><a href="read.section.html">read.section</a>()</code>,
<code><a href="section.html">section</a></code>,
<code><a href="section-class.html">section-class</a></code>,
<code><a href="sectionAddStation.html">sectionAddStation</a>()</code>,
<code><a href="sectionGrid.html">sectionGrid</a>()</code>,
<code><a href="sectionSmooth.html">sectionSmooth</a>()</code>,
<code><a href="subset-section-method.html">subset,section-method</a></code>,
<code><a href="summary-section-method.html">summary,section-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</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dankelley.github.io/oce/">oce</a></span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">section</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">sectionByLongitude</span> <span class="op">&lt;-</span> <span class="fu">sectionSort</span><span class="op">(</span><span class="va">section</span>, by <span class="op">=</span> <span class="st">"longitude"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">section</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Section 'a03' has 6 stations:</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Index    ID      Lon      Lat  Levels Depth</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     1     3   -8.526   36.876       5   202</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     2     4   -8.620   36.719      16   742</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     3     6   -8.738   36.538      19  1567</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     4     7   -8.791   36.425      24  2349</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     5     8   -8.901   36.250      23  2629</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     6     9   -9.271   36.235      24  3842</span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">sectionByLongitude</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Section 'a03' has 6 stations:</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Index    ID      Lon      Lat  Levels Depth</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     1   133  -73.673   38.237       8   154</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     2   132  -73.605   38.205      13   843</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     3   131  -73.491   38.158      16  1378</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     4   130  -73.319   38.086      20  2024</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     5   129  -73.156   38.004      22  2363</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     6   128  -72.976   37.925      24  2574</span>
<span class="r-in"><span></span></span>
</code></pre></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>

