<!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>Summarize an adv Object — summary,adv-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="Summarize an adv Object — summary,adv-method"><meta name="description" content="Summarize data in an adv object."><meta property="og:description" content="Summarize data in an adv object."></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>Summarize an adv Object</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/adv.R" class="external-link"><code>R/adv.R</code></a></small>
      <div class="d-none name"><code>summary-adv-method.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Summarize data in an <code>adv</code> object.</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 'adv'</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">object</span>, <span class="va">...</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-object">object<a class="anchor" aria-label="anchor" href="#arg-object"></a></dt>
<dd><p>an object of class <code>"adv"</code>, usually, a result of a call to
<code><a href="read.adv.html">read.adv()</a></code>.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>further arguments passed to or from other methods.</p></dd>

</dl></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 adv data:
<code><a href="sub-sub-adv-method.html">[[,adv-method</a></code>,
<code>[[&lt;-,adv-method</code>,
<code><a href="adv.html">adv</a></code>,
<code><a href="adv-class.html">adv-class</a></code>,
<code><a href="advSontekAdrFileTrim.html">advSontekAdrFileTrim</a>()</code>,
<code><a href="applyMagneticDeclination-adv-method.html">applyMagneticDeclination,adv-method</a></code>,
<code><a href="beamName.html">beamName</a>()</code>,
<code><a href="beamToXyz.html">beamToXyz</a>()</code>,
<code><a href="enuToOther.html">enuToOther</a>()</code>,
<code><a href="enuToOtherAdv.html">enuToOtherAdv</a>()</code>,
<code><a href="plot-adv-method.html">plot,adv-method</a></code>,
<code><a href="read.adv.html">read.adv</a>()</code>,
<code><a href="read.adv.nortek.html">read.adv.nortek</a>()</code>,
<code><a href="read.adv.sontek.adr.html">read.adv.sontek.adr</a>()</code>,
<code><a href="read.adv.sontek.serial.html">read.adv.sontek.serial</a>()</code>,
<code><a href="read.adv.sontek.text.html">read.adv.sontek.text</a>()</code>,
<code><a href="rotateAboutZ.html">rotateAboutZ</a>()</code>,
<code><a href="subset-adv-method.html">subset,adv-method</a></code>,
<code><a href="toEnu.html">toEnu</a>()</code>,
<code><a href="toEnuAdv.html">toEnuAdv</a>()</code>,
<code><a href="velocityStatistics.html">velocityStatistics</a>()</code>,
<code><a href="xyzToEnu.html">xyzToEnu</a>()</code>,
<code><a href="xyzToEnuAdv.html">xyzToEnuAdv</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">adv</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">adv</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> ADV Summary</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> -----------</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Instrument:    vector, serial number ``(serial number redacted)``</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Filename:      `(file name redacted)`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Location:      47.87943 N ,  -69.72533 E </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Time: 2008-07-01 00:00:00 to 2008-07-01 00:00:59 (480 samples, mean increment 0.1250001 s)</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Data Overview</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>                          Min.                Mean                Max.                Dim.    NAs</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     v [m/s]              -0.080871           0.00069514          0.057789            "480x3" 0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     a                    NA                  NA                  NA                  "480x3" 0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     q                    NA                  NA                  NA                  "480x3" 0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     time                 2008-07-01 00:00:00 2008-07-01 00:00:30 2008-07-01 00:00:59 480     0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     pressure [dbar]      16.85               16.866              16.879              480     0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     timeBurst            NA                  NA                  NA                  480     480</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     recordsBurst         NA                  NA                  NA                  480     480</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     voltageSlow          9.7                 9.71                9.8                 60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     timeSlow             2008-07-01 00:00:00 2008-07-01 00:00:30 2008-07-01 00:00:59 60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     headingSlow [°]      -23.39              -23.39              -23.39              60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     pitchSlow [°]        0.4                 0.5                 0.6                 60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     rollSlow [°]         -6.2                -6.145              -6.1                60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     temperatureSlow [°C] 6.47                6.4997              6.51                60      0  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Processing Log</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:53:39 UTC: `read.oce(file = "/data/archive/sleiwex/2008/moorings/m05/adv/nortek_1943/raw/adv_nortek_1943.vec",     from = as.POSIXct("2008-06-25 00:00:00", tz = "UTC"), to = as.POSIXct("2008-07-06 00:00:00",         tz = "UTC"), latitude = 47.87943, longitude = -69.72533)`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:53:54 UTC: `retime(x = m05VectorBeam, a = 0.58, b = 6.3892e-07, t0 = as.POSIXct("2008-07-01 00:00:00",     tz = "UTC"))`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:53:55 UTC: `subset(x, subset=as.POSIXct("2008-06-25 13:00:00", tz = "UTC") &lt;= time &amp; time &lt;=      as.POSIXct("2008-07-03 00:50:00", tz = "UTC"))`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:53:55 UTC: `oceEdit(x = m05VectorBeam, item = "transformationMatrix", value = rbind(c(11033,     -5803, -5238), c(347, -9622, 9338), c(-1418, -1476, -1333))/4096,     reason = "Nortek email 2011-02-14", person = "DEK")`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:53:55 UTC: `use aquadoppHR heading; despike own pitch and roll`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:54:11 UTC: `beamToXyzAdv(x = x)`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2015-12-23 17:54:34 UTC: `xyzToEnu(x, declination=-18.099, horizontalCase=TRUE, sensorOrientiation=upward, debug=0)`</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>

