<!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>Class to Store Bremen-formatted Data — bremen-class • 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="Class to Store Bremen-formatted Data — bremen-class"><meta name="description" content="This class is for data stored in a format used at Bremen.
It is somewhat similar to the odf, in the sense
that it does not apply just to a particular instrument.
Although some functions are provided for dealing with these
data (see &amp;#8220;Details&amp;#8221;), the most common action is to read the
data with read.bremen(), and then to coerce the object to
another storage class (e.g. using as.ctd() for CTD-style
data) so that specialized functions can be used thereafter."><meta property="og:description" content="This class is for data stored in a format used at Bremen.
It is somewhat similar to the odf, in the sense
that it does not apply just to a particular instrument.
Although some functions are provided for dealing with these
data (see &amp;#8220;Details&amp;#8221;), the most common action is to read the
data with read.bremen(), and then to coerce the object to
another storage class (e.g. using as.ctd() for CTD-style
data) so that specialized functions can be used thereafter."></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>Class to Store Bremen-formatted Data</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/bremen.R" class="external-link"><code>R/bremen.R</code></a></small>
      <div class="d-none name"><code>bremen-class.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>This class is for data stored in a format used at Bremen.
It is somewhat similar to the <a href="odf-class.html">odf</a>, in the sense
that it does not apply just to a particular instrument.
Although some functions are provided for dealing with these
data (see “Details”), the most common action is to read the
data with <code><a href="read.bremen.html">read.bremen()</a></code>, and then to coerce the object to
another storage class (e.g. using <code><a href="as.ctd.html">as.ctd()</a></code> for CTD-style
data) so that specialized functions can be used thereafter.</p>
    </div>


    <div class="section level2">
    <h2 id="slots">Slots<a class="anchor" aria-label="anchor" href="#slots"></a></h2>


<dl><dt><code>data</code></dt>
<dd><p>As with all <code>oce</code> objects, the <code>data</code> slot
for <code>bremen</code> objects is a
<a href="https://rdrr.io/r/base/list.html" class="external-link">list</a> containing the main data for the object.</p></dd>


<dt><code>metadata</code></dt>
<dd><p>As with all <code>oce</code> objects, the <code>metadata</code> slot
for <code>bremen</code> objects is a <a href="https://rdrr.io/r/base/list.html" class="external-link">list</a> containing
information about the <code>data</code> or about the object itself.</p></dd>


<dt><code>processingLog</code></dt>
<dd><p>As with all <code>oce</code> objects, the <code>processingLog</code> slot
for <code>bremen</code> objects is a
<a href="https://rdrr.io/r/base/list.html" class="external-link">list</a> with entries describing the creation and evolution
of the object. The contents are updated by various <code>oce</code> functions to
keep a record of processing steps.  Object summaries and
<code><a href="processingLogShow.html">processingLogShow()</a></code> both display the log.</p></dd>


</dl></div>
    <div class="section level2">
    <h2 id="modifying-slot-contents">Modifying slot contents<a class="anchor" aria-label="anchor" href="#modifying-slot-contents"></a></h2>



<p>Although the <code>[[&lt;-</code> operator may permit modification of the contents
of bremen objects (see <code>[[&lt;-,bremen-method</code>),
it is better to use <code><a href="oceSetData.html">oceSetData()</a></code> and <code><a href="oceSetMetadata.html">oceSetMetadata()</a></code>,
because those functions save an entry in the <code>processingLog</code>
that describes the change.</p>
    </div>
    <div class="section level2">
    <h2 id="retrieving-slot-contents">Retrieving slot contents<a class="anchor" aria-label="anchor" href="#retrieving-slot-contents"></a></h2>



<p>The full contents of the <code>data</code> and <code>metadata</code> slots of a bremen
object may be retrieved in the standard R way using <code><a href="https://rdrr.io/r/methods/slot.html" class="external-link">slot()</a></code>. For
example <code>slot(o,"data")</code> returns the <code>data</code> slot of an object named <code>o</code>,
and similarly <code>slot(o,"metadata")</code> returns
the <code>metadata</code> slot.</p>
<p>The slots may also be obtained with the <code><a href="sub-sub-bremen-method.html">[[,bremen-method</a></code>
operator, as e.g. <code>o[["data"]]</code> and <code>o[["metadata"]]</code>, respectively.</p>
<p>The <code><a href="sub-sub-bremen-method.html">[[,bremen-method</a></code> operator can also
be used to retrieve items from within the <code>data</code> and <code>metadata</code> slots.
For example, <code>o[["temperature"]]</code> can be used to retrieve temperature
from an object containing that quantity. The rule is that a named
quantity is sought first within the object's <code>metadata</code> slot,
with the <code>data</code> slot being checked only if <code>metadata</code> does not
contain the item. This <code>[[</code> method can also be used to get
certain derived quantities, if the object contains sufficient
information to calculate them. For example, an object that holds
(practical) salinity, temperature and pressure, along with
longitude and latitude, has sufficient information to compute
Absolute Salinity, and so <code>o[["SA"]]</code> will yield the
calculated Absolute Salinity.</p>
<p>It is also possible to find items more directly, using <code><a href="oceGetData.html">oceGetData()</a></code> and
<code><a href="oceGetMetadata.html">oceGetMetadata()</a></code>, but neither of these functions can
retrieve derived items.</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 classes provided by oce:
<code><a href="adp-class.html">adp-class</a></code>,
<code><a href="adv-class.html">adv-class</a></code>,
<code><a href="argo-class.html">argo-class</a></code>,
<code><a href="cm-class.html">cm-class</a></code>,
<code><a href="coastline-class.html">coastline-class</a></code>,
<code><a href="ctd-class.html">ctd-class</a></code>,
<code><a href="lisst-class.html">lisst-class</a></code>,
<code><a href="lobo-class.html">lobo-class</a></code>,
<code><a href="met-class.html">met-class</a></code>,
<code><a href="oce-class.html">oce-class</a></code>,
<code><a href="odf-class.html">odf-class</a></code>,
<code><a href="rsk-class.html">rsk-class</a></code>,
<code><a href="sealevel-class.html">sealevel-class</a></code>,
<code><a href="section-class.html">section-class</a></code>,
<code><a href="topo-class.html">topo-class</a></code>,
<code><a href="windrose-class.html">windrose-class</a></code>,
<code><a href="xbt-class.html">xbt-class</a></code></p>
<p>Other things related to bremen data:
<code><a href="sub-sub-bremen-method.html">[[,bremen-method</a></code>,
<code>[[&lt;-,bremen-method</code>,
<code><a href="plot-bremen-method.html">plot,bremen-method</a></code>,
<code><a href="read.bremen.html">read.bremen</a>()</code>,
<code><a href="summary-bremen-method.html">summary,bremen-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>

  </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>

