<!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 a cm Object — summary,cm-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 a cm Object — summary,cm-method"><meta name="description" content="Summarizes some of the data in a cm object, presenting such information
as the station name, sampling location, data ranges, etc."><meta property="og:description" content="Summarizes some of the data in a cm object, presenting such information
as the station name, sampling location, data ranges, etc."></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 a cm Object</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/cm.R" class="external-link"><code>R/cm.R</code></a></small>
      <div class="d-none name"><code>summary-cm-method.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Summarizes some of the data in a <code>cm</code> object, presenting such information
as the station name, sampling location, data ranges, etc.</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 'cm'</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>A <a href="cm-class.html">cm</a> object.</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>The documentation for the <a href="cm-class.html">cm</a> class explains the structure
of <code>cm</code> objects, and also outlines the other functions dealing with them.</p>
<p>Other things related to cm data:
<code><a href="sub-sub-cm-method.html">[[,cm-method</a></code>,
<code>[[&lt;-,cm-method</code>,
<code><a href="applyMagneticDeclination-cm-method.html">applyMagneticDeclination,cm-method</a></code>,
<code><a href="as.cm.html">as.cm</a>()</code>,
<code><a href="cm.html">cm</a></code>,
<code><a href="cm-class.html">cm-class</a></code>,
<code><a href="plot-cm-method.html">plot,cm-method</a></code>,
<code><a href="read.cm.html">read.cm</a>()</code>,
<code><a href="rotateAboutZ.html">rotateAboutZ</a>()</code>,
<code><a href="subset-cm-method.html">subset,cm-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">cm</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">cm</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Cm 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> * File source:   "/Users/kelley/Dropbox/data/archive/sleiwex/2008/moorings/m11/cm/interocean_0811786/manufacturer/cm_interocean_0811786.s4a.tab"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Instr. type:   (2Hz)S4</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Serial Num.:   8111786</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Version:       2.399</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * North:         magnetic</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> * Time: 2008-06-26 to 2008-06-26 23:59:00 (1440 samples, mean increment 1 min)</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  OriginalName</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Sample..                 842        1561.5              2281                1440 0    "Sample #"  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Date                     NA         NA                  NA                  1440 0    "Date"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Time                     NA         NA                  NA                  1440 0    "Time"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     dec.S                    0          0                   0                   1440 0    "dec S"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     v [m/s]                  -0.862     -0.088736           0.74                1440 0    "Vnorth"    </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     u [m/s]                  -0.478     0.02761             0.654               1440 0    "Veast"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Speed                    1.44       53.569              98.29               1440 0    "Speed"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Dir                      7          126.99              352.1               1440 0    "Dir"       </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Vref                     NA         NA                  NA                  1440 1440 "Vref"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hx                       -210       -31.052             177                 1440 0    "Hx"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hy                       -212       -0.58889            211                 1440 0    "Hy"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     conductivity [mS/cm]     36.8       36.924              37.2                1440 0    "Cond"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     temperature [°C, ITS-90] 1.204      2.0773              3.065               1440 0    "T-Temp"    </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Depth                    73.242     74.767              77.148              1440 0    "Depth"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     none                     NA         NA                  NA                  1440 1440 "none"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     none.1                   NA         NA                  NA                  1440 1440 "none"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hdg                      0          175.79              359.2               1440 0    "Hdg"       </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     X                        NA         NA                  NA                  1440 1440 "-"         </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     salinity [PSS-78]        41.307     42.71               44.205              1440 0    "Sal"       </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Dens                     1033.3     1034.5              1035.8              1440 0    "Dens"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     SV                       1467.9     1469.8              1472.2              1440 0    "SV"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     X.1                      NA         NA                  NA                  1440 1440 "-"         </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     N.S.Dist                 -2535.2    4159.5              10349               1440 0    "N-S Dist"  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     E.W.Dist                 -2033.5    893.81              4687.5              1440 0    "E-W Dist"  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     X.2                      NA         NA                  NA                  1440 1440 "-"         </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     SRB.Date                 NA         NA                  NA                  1440 1440 "SRB Date"  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     SRB.Time                 NA         NA                  NA                  1440 0    "SRB Time"  </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Vref.1                   1.226      1.2263              1.23                1440 1152 "Vref"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hx.1                     NA         NA                  NA                  1440 1440 "Hx"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hy.1                     NA         NA                  NA                  1440 1440 "Hy"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Cond.1                   NA         NA                  NA                  1440 1440 "Cond"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     T.Temp.1                 NA         NA                  NA                  1440 1440 "T-Temp"    </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Depth.1                  NA         NA                  NA                  1440 1440 "Depth"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     none.2                   NA         NA                  NA                  1440 1440 "none"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     none.3                   NA         NA                  NA                  1440 1440 "none"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Hdg.1                    NA         NA                  NA                  1440 1440 "Hdg"       </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     X.3                      NA         NA                  NA                  1440 1440 "-"         </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Sal.1                    NA         NA                  NA                  1440 1440 "Sal"       </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     Dens.1                   NA         NA                  NA                  1440 1440 "Dens"      </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     SV.1                     NA         NA                  NA                  1440 1440 "SV"        </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     pressure [dbar]          73.855     75.392              77.794              1440 0    "-"         </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     time                     2008-06-26 2008-06-26 11:59:30 2008-06-26 23:59:00 1440 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>     - 2023-02-10 12:50:57 UTC: `create 'cm' object`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2023-02-10 12:50:57 UTC: `read.oce("~/data/archive/sleiwex/2008/moorings/m11/cm/interocean_0811786/manufacturer/cm_interocean_0811786.s4a.tab", ...)`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>     - 2023-02-10 12:50:57 UTC: `subset.cm(x, subset=time &lt; as.POSIXct("2008-06-27 00:00:00", tz = "UTC"))`</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>

