Commit d0eb6bf8 authored by Ryan Gosse's avatar Ryan Gosse

Added .rd files for glatos_to_att and modified Readme to explain the new function

parent e58690a5
......@@ -32,6 +32,7 @@
#' rcv <- read_glatos_receivers(rec_file) # load receiver data
#'
#' ATTData <- glatos_to_att(walleye_detections, rcv)
#' @export
glatos_to_att <- function(glatosObj, receiverObj) {
......
......@@ -58,3 +58,8 @@ species and individual animals.
4. [`adjust_playback_time`](https://gitlab.oceantrack.org/GreatLakes/glatos/blob/master/R/vis-adjust_playback_time.r) modify playback speed of videos and optionally convert between video file formats. Requires *FFmpeg*
#### Data Exporting
1. [`glatos_to_att`](https://gitlab.oceantrack.org/GreatLakes/glatos/blob/master/R/util-glatos_to_att.r) converts the glatos
detection and receiver objects to a format support by [VTrack](https://github.com/RossDwyer/VTrack)/[ATT](https://github.com/vinayudyawer/ATT).
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/util-glatos_to_att.r
\name{glatos_to_att}
\alias{glatos_to_att}
\title{Convert detections and receiver metadata to a format that
ATT (https://github.com/vinayudyawer/ATT) accepts.}
\usage{
glatos_to_att(glatosObj, receiverObj)
}
\arguments{
\item{glatosObj}{a list from \code{read_glatos_detections}}
\item{receiverObj}{a list from \code{read_glatos_receivers}}
}
\value{
a list of 3 tibbles containing tag dectections, tag metadata, and
station metadata, to be injested by VTrack/ATT
}
\description{
Convert detections and receiver metadata to a format that
ATT (https://github.com/vinayudyawer/ATT) accepts.
}
\details{
This function takes 2 lists containing detection and
reciever data and transforms them into 3 \code{tibble} objects
inside of a list. The input that AAT uses to get this data product
is located here: https://github.com/vinayudyawer/ATT/blob/master/README.md
and our mappings are found here: https://gitlab.oceantrack.org/GreatLakes/glatos/issues/83
in a comment by Ryan Gosse
}
\examples{
#--------------------------------------------------
# EXAMPLE #1 - loading from the vignette data
library(glatos)
wal_det_file <- system.file("extdata", "walleye_detections.csv",
package = "glatos")
walleye_detections <- read_glatos_detections(wal_det_file) # load walleye data
rec_file <- system.file("extdata", "sample_receivers.csv",
package = "glatos")
rcv <- read_glatos_receivers(rec_file) # load receiver data
ATTData <- glatos_to_att(walleye_detections, rcv)
}
\author{
Ryan Gosse
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment