R/data.R

In inbo/camtraptor: Read, Explore and Visualize Camera Trap Data Packages

#' Sample of Camtrap DP formatted data
#'
#' A sample [Camera Trap Data Package](https://camtrap-dp.tdwg.org) as
#' read by [read_camtrap_dp()].
#' The source data are derived from the [Camtrap DP example dataset](
#' https://github.com/tdwg/camtrap-dp/tree/ad0278ef86ef518dacfb306c598dce97667cfb81/example)
#' and are saved in `inst/extdata/mica`.
#'
#' A larger dataset is available in `inst/extdata/mica_zenodo_5590881`.
#' It is derived from a dataset on [Zenodo](https://zenodo.org/record/5590881),
#' but excludes `media.csv`.
#'
#' @family sample data
#' @source
#' <https://github.com/tdwg/camtrap-dp/tree/ad0278ef86ef518dacfb306c598dce97667cfb81/example>
#' @examples
#' \dontrun{
#' # mica.rda was created with the code below.
#' mica <- read_camtrap_dp(
#'   system.file(
#'     "extdata/mica",
#'     "datapackage.json",
#'     package = "camtraptor"
#'   )
#' )
#' save(mica, file = "data/mica.rda")
#' }
"mica"

#' Sample of animal position digitization data
#'
#' A tibble data frame with the following columns:
#' - `deploymentID`
#' - `sequenceID`
#' - `x` and `y`: The coordinates.
#' - `imageWidth` and `imageHeight`: The image dimensions.
#'
#' @family sample data
"animal_positions"

#' Sample of deployment calibration models
#'
#' A list containing a number of calibration models (`calibs`) or site
#' calibration models (`depcal`).
#' The deployment names are used as names.
#'
#' @family sample data
"dep_calib_models"