R/get_agest.R

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

#' Get aging structure options - A list of aging structure codes used in GLIS
#'
#' This function accesses the api endpoint for aging structure choices and returns
#' their labels, descriptions and whether they're in use. It can fetch the entire
#' table of valid aging structures, or it accepts the filter parameter all=TRUE
#' to return all aging structures, including those no longer in use. No other
#' filter parameters are currently available for this endpoint.
#'
#' Note that aging structures are valid for the AGEST field and the first
#' character of the AGEMT field.
#'
#'
#' See
#' https://intra.glis.mnr.gov.on.ca/common/aging_structures/
#' for the full list of aging structure code options
#'
#'
#' @param filter_list list
#'
#' @param show_id include the fields the 'id' and 'slug' in the
#' returned data frame
#'
#' @param to_upper - should the names of the dataframe be converted to
#' upper case?
#'
#' @author Rachel Henderson \email{rachel.henderson@@ontario.ca}
#' @return dataframe
#' @export
#' @examples
#'
#' agest <- get_agest()
#' agest_all <- get_agest(list(all = TRUE))
#' agest_slugs <- get_agest(show_id = TRUE)
get_agest <- function(filter_list = list(), show_id = FALSE, to_upper = TRUE) {
  query_string <- build_query_string(filter_list)
  common_api_url <- get_common_portal_root()
  # check_filters("aging_structures", filter_list, "common")
  # TODO: add a warning about 'all=TRUE' being the only allowed filter

  my_url <- sprintf(
    "%s/aging_structures/%s",
    common_api_url,
    query_string
  )
  payload <- api_to_dataframe(my_url)
  payload <- prepare_payload(payload, show_id, to_upper)

  return(payload)
}