R/get_SC127.R

In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

#' Get SC127 - Diet data from Creel_Portal API
#'
#' This function accesses the api endpoint to for SC127 - age
#' estimate/interpretations.  This function takes an optional filter
#' list which can be used to return records based on several different
#' attributes of the age estimate such as the assigned age, the aging
#' structure, confidence, number of complete annuli and edge code, or
#' whether or not it was identified as the 'preferred' age for this
#' fish. Additionally, filters can be applied to select age estimates
#' based on attributes of the sampled fish such as the species, or
#' group code, or attributes of the effort, the sample, or the
#' project(s) that the samples were collected in.
#'
#' Use \code{show_filters("sc127")} to see the full list of available filter
#' keys (query parameters). Refer to
#' \url{https://intra.glis.mnr.gov.on.ca/creels/api/v1/swagger/}
#' and filter by "sc127" for additional information.
#'
#' @param filter_list list
#' @param show_id When 'FALSE', the default, the 'id' and 'slug'
#'   fields are hidden from the data frame. To return these columns as
#'   part of the data frame, use 'show_id = TRUE'.
#' @param to_upper - should the names of the dataframe be converted to
#'   upper case?
#'
#' @author Adam Cottrill \email{adam.cottrill@@ontario.ca}
#' @return dataframe
#' @export
#' @examples
#'
#' sc127 <- get_SC127(list(lake = "ON", year = 2012, spc = "334"))
#'
#' filters <- list(lake = "HU", spc = "076", grp = "55")
#' sc127 <- get_SC127(filters)
#' sc127 <- get_SC127(filters, show_id = TRUE)
get_SC127 <- function(filter_list = list(), show_id = FALSE, to_upper = TRUE) {
  recursive <- ifelse(length(filter_list) == 0, FALSE, TRUE)
  query_string <- build_query_string(filter_list)
  check_filters("sc127", filter_list, api_app = "creels")
  my_url <- sprintf(
    "%s/sc127/%s",
    get_sc_portal_root(),
    query_string
  )
  payload <- api_to_dataframe(my_url, recursive = recursive)
  payload <- prepare_payload(payload, show_id, to_upper)

  return(payload)
}