| Title: | Miscellaneous data and helper functions for using YAPS |
|---|---|
| Description: | Provides a bit of data and helper functions for wrapping around the key YAPS functions. The main function is swim_yaps, which will allow you to pass a data.table that is formatted with columns ts, epo, frac, tag, serial to the function. You must have a synchronisation model already available that is named sync_model and a data.table object for the hydrophones and their locations named hydros, as per the YAPS specifications. You should be familiar with YAPS in order to use this package but it will hopefully help make your life easier by looping through YAPS runs N (user specified number) of times and taking the best fit among those runs for each fish day. You will also find some data in the package to help you try. |
| Authors: | Robert Lennox [aut, cre] |
| Maintainer: | Robert Lennox <[email protected]> |
| License: | CC0 |
| Version: | 0.0.0.9000 |
| Built: | 2024-10-30 04:01:24 UTC |
| Source: | https://github.com/robertlennox/miscYAPS |
functions to get receiver and tagging metadata into session
swim_yaps(fish_detections, runs, rbi_min, rbi_max)swim_yaps(fish_detections, runs, rbi_min, rbi_max)
fish_detections |
the data frame with the fish detections including epo and frac |
runs |
number of times to refit the model |
rbi_min |
the minimum random burst interval of the transmitter |
rbi_max |
the maximum random burst interval of the transmitter |
functions to get receiver and tagging metadata into session
hydros |
the hydrophone data frame as a data.table |
detections |
a data.table of the sync tag detections |
ss_data |
a data.table of the speed of sound data formatted using yaps::tempToSs |
HOW_THIN |
is the number for the eps_threshold.. smaller makes a thinner distribution default is 50 |
keep_rate |
what proportion of sync tag detections do you want to retain, default is 1 (100%) |
timekeeper |
is the idx of the most perfectly fixed hydrophone; refer to hydros data.table for idx numbers |
functions to get receiver and tagging metadata into session
fish_detections |
the data frame with the fish detections including epo and frac |
rbi_min |
the minimum random burst interval of the transmitter |
rbi_max |
the maximum random burst interval of the transmitter |
runs |
number of times to refit the model |
silent |
do you want to hide all the TMB code running? Default is yes (TRUE) |