R/tg_expeditions.R

In fishvice/taggart: Convenient function for smartfish

#' Expeditions
#'
#' @param species "mackerel" or "herring"
#' @param cn.standardized Boolean, if FALSE (default) retains variable names as
#' delivered by the webserver otherwise mri-standaridzed variable names are used
#' @return A dataframe
#' @export
#'
tg_expeditions <- function(species = "mackerel", cn.standardized = FALSE) {

  if(length(species) > 1) {
    stop(message("Only one species can be specified, 'mackerel' or 'herring'"))
  }

  if(!any(species %in% c("herring", "mackerel"))) {
    stop(message("species has to be either 'mackerel' or 'herring'"))
  }

  d <-
    jsonlite::fromJSON(paste0("http://smartfishsvc.hi.no/api/data/expeditions/", species[1])) %>%
    dplyr::as_tibble() %>%
    dplyr::select_all(tolower) %>%
    dplyr::mutate(when = lubridate::ymd_hms(when),
                  relesedate = lubridate::ymd_hms(relesedate),
                  recapturedate = lubridate::ymd_hms(recapturedate),
                  lo = stringr::str_replace(lo, ",", ".") %>% as.numeric(),
                  la = stringr::str_replace(la, ",", ".") %>% as.numeric(),
                  length = length * 100,
                  species = species[1])

  if(!cn.standardized) {
    return(d)
  } else {
    d %>%
      dplyr::rename(tDate = relesedate,
                    rDate = recapturedate,
                    species = fish,
                    tLon = lo,
                    tLat = la,
                    tLength = length) %>%
      return()
  }
}