formatEffort

Format effort data for use in other acoustic detection plotting
functions. Time ranges will be marked as either "on" or "off" effort

A variety of tools relevant to the analysis
of marine soundscape data. There are tools for downloading AIS (automatic identification system)
data from Marine Cadastre <https://hub.marinecadastre.gov>,
connecting AIS data to GPS coordinates, plotting summaries of various soundscape
measurements, and downloading relevant environmental variables (wind, swell height) from the
National Center for Atmospheric Research data server <https://rda.ucar.edu/datasets/ds084.1/>.
Most tools were developed to work well with output from 'Triton' software, but can be adapted
to work with any similar measurements.

Taiki Sakai

PAMscapes

Tools for Summarising and Analysing Soundscape Data

Anne Simonis

Kaitlin Palmer

Megan McKenna

Shannon Rankin

formatEffort function

<dl><dt>effort</dt>
<dd>dataframe with columns <code>start</code> and <code>end</code> describing
on effort time ranges</dd>
<dt>range</dt>
<dd>if not <code>NULL</code>, the full extent time ranges to consider for
marking off effort times</dd>
<dt>resolution</dt>
<dd>if not <code>NULL</code>, time resolution to round effort start
and end times to. Start times will use <a href="https://lubridate.tidyverse.org/reference/round_date.html">floor_date</a> and
end times will use <a href="https://lubridate.tidyverse.org/reference/round_date.html">ceiling_date</a>, must be a character
that is valid for the <code>unit</code> argument of those functions</dd>
<dt>columns</dt>
<dd>if not <code>NULL</code>, extra columns to use for differentiating
different types of effort that should be tracked separately (e.g. different
deployment sites or species with different effort)</dd>
<dt>combineYears</dt>
<dd>logical flag to combine all years into a single "year"</dd></dl>

Arguments

Taiki Sakai <a href="/link/taiki.sakai%40noaa.gov?package=PAMscapes&version=0.11.3" data-mini-rdoc="PAMscapes::taiki.sakai@noaa.gov">taiki.sakai@noaa.gov</a>

Author

Format Detection Effort — formatEffort

<dl>

<dt>effort</dt>
<dd>dataframe with columns <code>start</code> and <code>end</code> describing
on effort time ranges</dd>


<dt>range</dt>
<dd>if not <code>NULL</code>, the full extent time ranges to consider for
marking off effort times</dd>


<dt>resolution</dt>
<dd>if not <code>NULL</code>, time resolution to round effort start
and end times to. Start times will use <a href='https://lubridate.tidyverse.org/reference/round_date.html'>floor_date</a> and
end times will use <a href='https://lubridate.tidyverse.org/reference/round_date.html'>ceiling_date</a>, must be a character
that is valid for the <code>unit</code> argument of those functions</dd>


<dt>columns</dt>
<dd>if not <code>NULL</code>, extra columns to use for differentiating
different types of effort that should be tracked separately (e.g. different
deployment sites or species with different effort)</dd>


<dt>combineYears</dt>
<dd>logical flag to combine all years into a single "year"</dd>

</dl>

Taiki Sakai <a href='mailto:taiki.sakai@noaa.gov'>taiki.sakai@noaa.gov</a>

formatEffort: Format Detection Effort

Description

Usage

Value

Arguments

Author