<!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>Show Some Values From a List, Vector or Matrix — vectorShow • 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="Show Some Values From a List, Vector or Matrix — vectorShow"><meta name="description" content="This is similar to str(), but it shows data at the first and last of the
vector, which can be quite helpful in debugging."><meta property="og:description" content="This is similar to str(), but it shows data at the first and last of the
vector, which can be quite helpful in debugging."></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>Show Some Values From a List, Vector or Matrix</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/misc.R" class="external-link"><code>R/misc.R</code></a></small>
      <div class="d-none name"><code>vectorShow.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>This is similar to <code><a href="https://rdrr.io/r/utils/str.html" class="external-link">str()</a></code>, but it shows data at the first and last of the
vector, which can be quite helpful in debugging.</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">vectorShow</span><span class="op">(</span></span>
<span>  <span class="va">v</span>,</span>
<span>  msg <span class="op">=</span> <span class="st">""</span>,</span>
<span>  postscript <span class="op">=</span> <span class="st">""</span>,</span>
<span>  digits <span class="op">=</span> <span class="fl">5L</span>,</span>
<span>  n <span class="op">=</span> <span class="fl">2L</span>,</span>
<span>  showNA <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  showNewline <span class="op">=</span> <span class="cn">TRUE</span></span>
<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-v">v<a class="anchor" aria-label="anchor" href="#arg-v"></a></dt>
<dd><p>the item to be summarized.  If this is a list of a vector of named
items, then information is provided for each element. Otherwise, information
is provided for the first and last <code>n</code> values.</p></dd>


<dt id="arg-msg">msg<a class="anchor" aria-label="anchor" href="#arg-msg"></a></dt>
<dd><p>optional character value indicating a message to show,
introducing the vector.  If not provided, then
a message is created from <code>v</code>. If <code>msg</code> is a non-empty string,
then that string is pasted together with a colon (unless <code>msg</code> already
contains a colon), before pasting a summary of data values.</p></dd>


<dt id="arg-postscript">postscript<a class="anchor" aria-label="anchor" href="#arg-postscript"></a></dt>
<dd><p>optional character value indicating an optional message
to append at the end of the return value.</p></dd>


<dt id="arg-digits">digits<a class="anchor" aria-label="anchor" href="#arg-digits"></a></dt>
<dd><p>for numerical values of <code>v</code>, this is the number of digits
to use, in formatting the numbers with <code><a href="https://rdrr.io/r/base/format.html" class="external-link">format()</a></code>; otherwise,
<code>digits</code> is ignored.</p></dd>


<dt id="arg-n">n<a class="anchor" aria-label="anchor" href="#arg-n"></a></dt>
<dd><p>number of elements to show at start and end. If <code>n</code>
is negative, then all the elements are shown.</p></dd>


<dt id="arg-showna">showNA<a class="anchor" aria-label="anchor" href="#arg-showna"></a></dt>
<dd><p>logical value indicating whether to show the number
of <code>NA</code> values. This is done only if the output contains ellipses,
meaning that some values are skipped, because if all values are shown,
it will be perfectly obvious whether there are any <code>NA</code> values.</p></dd>


<dt id="arg-shownewline">showNewline<a class="anchor" aria-label="anchor" href="#arg-shownewline"></a></dt>
<dd><p>logical value indicating whether to put a newline
character at the end of the output string.  The default, TRUE, is
convenient for printing, but using FALSE makes more sense if
the result is to be used with, e.g. <code><a href="https://rdrr.io/r/graphics/mtext.html" class="external-link">mtext()</a></code>.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A string ending in a newline character, suitable for
display with <code><a href="https://rdrr.io/r/base/cat.html" class="external-link">cat()</a></code> or <code><a href="oceDebug.html">oceDebug()</a></code>.</p>
    </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="co"># List</span></span></span>
<span class="r-in"><span><span class="va">limits</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>low <span class="op">=</span> <span class="fl">0</span>, high <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="va">limits</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "limits: low=0, high=1\n"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Vector of named items</span></span></span>
<span class="r-in"><span><span class="va">planktonCount</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>phytoplankton <span class="op">=</span> <span class="fl">100</span>, zooplankton <span class="op">=</span> <span class="fl">20</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="va">planktonCount</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "planktonCount: phytoplankton=100, zooplankton=20\n"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Vector</span></span></span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="va">pi</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "pi: 3.1416\n"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Matrix</span></span></span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="va">volcano</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "volcano[1:87, 1:61]: 100, 101, ..., 94, 94\n"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Other arguments</span></span></span>
<span class="r-in"><span><span class="va">knot2mps</span> <span class="op">&lt;-</span> <span class="fl">0.5144444</span></span></span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="va">knot2mps</span>, postscript <span class="op">=</span> <span class="st">"knots per m/s"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "knot2mps: 0.51444 knots per m/s\n"</span>
<span class="r-in"><span><span class="fu">vectorShow</span><span class="op">(</span><span class="st">"January"</span>, msg <span class="op">=</span> <span class="st">"The first month is"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "The first month is: January\n"</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>

