<!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.0"><title>Filter the eBird data by protocol — auk_protocol • auk</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Filter the eBird data by protocol — auk_protocol"><meta property="og:description" content="Filter to just data collected following a specific search protocol:
stationary, traveling, or casual. This function only defines the filter and,
once all filters have been defined, auk_filter() should be used to call AWK
and perform the filtering."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">auk</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.7.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../articles/auk.html">Get started</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu"><li>
      <a href="../articles/development.html">auk development</a>
    </li>
  </ul></li>
<li>
  <a href="https://github.com/CornellLabofOrnithology/auk/blob/master/cheatsheet/auk-cheatsheet.pdf" class="external-link">Cheatsheet</a>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="https://github.com/CornellLabofOrnithology/auk/" class="external-link">
    <span class="fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Filter the eBird data by protocol</h1>
    <small class="dont-index">Source: <a href="https://github.com/CornellLabofOrnithology/auk/blob/HEAD/R/auk-protocol.R" class="external-link"><code>R/auk-protocol.R</code></a></small>
    <div class="hidden name"><code>auk_protocol.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Filter to just data collected following a specific search protocol:
stationary, traveling, or casual. This function only defines the filter and,
once all filters have been defined, <code><a href="auk_filter.html">auk_filter()</a></code> should be used to call AWK
and perform the filtering.</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">auk_protocol</span><span class="op">(</span><span class="va">x</span>, <span class="va">protocol</span><span class="op">)</span></span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>x</dt>
<dd><p><code>auk_ebd</code> or <code>auk_sampling</code> object; reference to file created by
<code><a href="auk_ebd.html">auk_ebd()</a></code> or <code><a href="auk_sampling.html">auk_sampling()</a></code>.</p></dd>


<dt>protocol</dt>
<dd><p>character. Many protocols exist in the database, however, the
most commonly used are:</p><ul><li><p>Stationary</p></li>
<li><p>Traveling</p></li>
<li><p>Area</p></li>
<li><p>Incidental</p></li>
</ul><p>A complete list of valid protocols is contained within the vector
<code>valid_protocols</code> within this package. Multiple protocols are allowed at
the same time.</p></dd>

</dl></div>
    <div id="value">
    <h2>Value</h2>
    

<p>An <code>auk_ebd</code> object.</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>This function can also work with on an <code>auk_sampling</code> object if the
user only wishes to filter the sampling event data.</p>
    </div>
    <div id="see-also">
    <h2>See also</h2>
    <div class="dont-index"><p>Other filter: 
<code><a href="auk_bbox.html">auk_bbox</a>()</code>,
<code><a href="auk_bcr.html">auk_bcr</a>()</code>,
<code><a href="auk_breeding.html">auk_breeding</a>()</code>,
<code><a href="auk_complete.html">auk_complete</a>()</code>,
<code><a href="auk_country.html">auk_country</a>()</code>,
<code><a href="auk_county.html">auk_county</a>()</code>,
<code><a href="auk_date.html">auk_date</a>()</code>,
<code><a href="auk_distance.html">auk_distance</a>()</code>,
<code><a href="auk_duration.html">auk_duration</a>()</code>,
<code><a href="auk_exotic.html">auk_exotic</a>()</code>,
<code><a href="auk_extent.html">auk_extent</a>()</code>,
<code><a href="auk_filter.html">auk_filter</a>()</code>,
<code><a href="auk_last_edited.html">auk_last_edited</a>()</code>,
<code><a href="auk_observer.html">auk_observer</a>()</code>,
<code><a href="auk_project.html">auk_project</a>()</code>,
<code><a href="auk_species.html">auk_species</a>()</code>,
<code><a href="auk_state.html">auk_state</a>()</code>,
<code><a href="auk_time.html">auk_time</a>()</code>,
<code><a href="auk_year.html">auk_year</a>()</code></p></div>
    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/system.file.html" class="external-link">system.file</a></span><span class="op">(</span><span class="st">"extdata/ebd-sample.txt"</span>, package <span class="op">=</span> <span class="st">"auk"</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="auk_ebd.html">auk_ebd</a></span><span class="op">(</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span></span>
<span class="r-in"><span>  <span class="fu">auk_protocol</span><span class="op">(</span><span class="st">"Stationary"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Input </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   EBD: /private/var/folders/mg/qh40qmqd7376xn8qxd6hm5lwjyy0h2/T/RtmpZtPd8G/temp_libpath583e1bad082b/auk/extdata/ebd-sample.txt </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Output </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Filters not executed</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Filters </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Species: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Countries: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   States: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Counties: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   BCRs: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Bounding box: full extent</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Years: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Date: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Start time: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Last edited date: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Protocol: Stationary</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Project code: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Duration: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Distance travelled: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Records with breeding codes only: no</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Exotic Codes: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Complete checklists only: no</span>
<span class="r-in"><span>  </span></span>
<span class="r-in"><span><span class="co"># alternatively, without pipes</span></span></span>
<span class="r-in"><span><span class="va">ebd</span> <span class="op">&lt;-</span> <span class="fu"><a href="auk_ebd.html">auk_ebd</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/system.file.html" class="external-link">system.file</a></span><span class="op">(</span><span class="st">"extdata/ebd-sample.txt"</span>, package <span class="op">=</span> <span class="st">"auk"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">auk_protocol</span><span class="op">(</span><span class="va">ebd</span>, <span class="st">"Stationary"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Input </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   EBD: /private/var/folders/mg/qh40qmqd7376xn8qxd6hm5lwjyy0h2/T/RtmpZtPd8G/temp_libpath583e1bad082b/auk/extdata/ebd-sample.txt </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Output </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Filters not executed</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Filters </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Species: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Countries: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   States: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Counties: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   BCRs: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Bounding box: full extent</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Years: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Date: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Start time: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Last edited date: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Protocol: Stationary</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Project code: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Duration: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Distance travelled: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Records with breeding codes only: no</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Exotic Codes: all</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>   Complete checklists only: no</span>
</code></pre></div>
    </div>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by <a href="http://strimas.com" class="external-link">Matthew Strimas-Mackey</a>, <a href="http://eliotmiller.weebly.com/" class="external-link">Eliot Miller</a>, <a href="https://www.birds.cornell.edu/hochachka/" class="external-link">Wesley Hochachka</a>.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.9.</p>
</div>

      </footer></div>

  


  

  </body></html>

