R/extdata.r

In ocean-tracking-network/glatos: A package for the Great Lakes Acoustic Telemetry Observation System

#' @title Zipped GLATOS detection file from Huron Erie Corridor Walleye project
#'
#' @description An example detection file
#'
#' @format A zipped walleye detection file in detection file format 1.3:
##'
#' @name raw_walleye_detections
#'
#' @section Filename: walleye_detections.zip
#'
#' @examples
#' system.file("extdata", "walleye_detections.zip", package = "glatos")
#'
#' @author Todd Hayden
#'
#' @source <http://glatos.glos.us/home/project/HECWL>
NULL


#' @title Raw GLATOS Workbook from St. Marys River Sea Lamprey project
#'
#' @description A completed GLATOS workbook from St. Marys River Sea Lamprey
#' project.
#'
#' @format A macro-enabled Microsoft Excel workbook file (*.xlsm) with six
#'  worksheets:
#'  \describe{
#'    \item{project}{project code, principal investigator and contact}
#'    \item{locations}{descriptions of receiver array locations}
#'    \item{proposed}{proposed receiver deployment locations and dates}
#'    \item{deployment}{receiver deployment data (what, where, when, how)}
#'    \item{recovery}{receiver recovery data (what, where, when, how)}
#'    \item{tagging}{animal collection, tagging, and recovery data}
#'  }
#'
#' @name raw_lamprey_workbook
#'
#' @section Filename: SMRSL_GLATOS_20140828.xlsm
#'
#' @examples
#' system.file("extdata", "SMRSL_GLATOS_20140828.xlsm", package = "glatos")
#'
#' @author Chris Holbrook
#'
#' @source <http://glatos.glos.us/home/project/SMRSL>
NULL


#' @title Video frames of walleye movements in Lake Huron
#'
#' @description Sequential images of walleye movements in Lake Huron
#'   for testing functionality of ffmpeg function.
#'
#' @format Folder contains 30 sequentially labeled .png image files
#'
#' @name video-images
#'
#' @section Filename: frames
#'
#' @examples
#' system.file("extdata", "frames", package = "glatos")
#'
#' @author Todd Hayden
#'
#' @source <http://glatos.glos.us/home/project/HECWL>
NULL

#' @title zipped polygon shapefile of Great Lakes
#'
#' @description Polygon coastline of Great Lakes in WGS84 projection.
#'
#' @format shapefile
#'
#' @name shoreline
#'
#' @section Filename: shoreline.zip
#'
#' @section Used to make [great_lakes_polygon].
#'
#' @details Note from Todd: "This polygon layer of GL shoreline was modified by
#'   hand to include Saginaw, Tittabawasssee, Maumee, and Sandusky rivers.
#'   Outlines of rivers are not precise but were wide enough to allow a
#'   continuous connection between pixels for the entire undammed river stretch
#'   when the 'rasterize' function is used to produce a raster layer of the GL
#'   in QGIS."
#'
#' @details Todd's original file name was 'coastline_poly_modified_rivers'.
#'
#' @examples
#'
#' # Read polygon from shapefile
#'
#' poly_file <- system.file("extdata", "shoreline.zip", package = "glatos")
#'
#' poly <- sf::st_read(paste0("/vsizip/", poly_file))
#'
#' \dontrun{
#' plot(sf::st_geometry(poly))
#' }
#'
#' @author Todd Hayden
#'
#' @source <http://glatos.glos.us/home>
NULL

#' @title Example animal data from the OTN ERDDAP
#'
#' @description An example animal data file from the OTN ERDDAP
#'
#' @format CSV
##'
#' @name otn_aat_animals
#'
#' @section Filename: otn_aat_animals.csv
#'
#' @examples
#' system.file("extdata", "otn_aat_animals.csv", package = "glatos")
#'
#' @source Ryan Gosse, Ocean Tracking Network
NULL

#' @title Example station data from the OTN ERDDAP
#'
#' @description An example receiver station data file from the OTN ERDDAP
#'
#' @format CSV
##'
#' @name otn_aat_receivers
#'
#' @section Filename: otn_aat_receivers.csv
#'
#' @examples
#' system.file("extdata", "otn_aat_receivers.csv", package = "glatos")
#'
#' @source Ryan Gosse, Ocean Tracking Network
NULL

#' @title Example tag release data from the OTN ERDDAP
#'
#' @description An example tag release data file from the OTN ERDDAP
#'
#' @format CSV
##'
#' @name otn_aat_tag_releases
#'
#' @section Filename: otn_aat_tag_releases.csv
#'
#' @examples
#' system.file("extdata", "otn_aat_tag_releases.csv", package = "glatos")
#'
#' @source Ryan Gosse, Ocean Tracking Network
NULL