R/get_tag_colours.R

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

#' Get tag colour options - A list of tag colour codes used in GLIS
#'
#' This function accesses the api endpoint for tag colour choices and returns
#' their labels, descriptions and whether they're in use. It fetches
#' the entire table of accepted tag colours - no other filter
#' parameters are currently available for this endpoint. Tag colour is the
#' fifth character of TAGDOC.
#'
#'
#' See
#' https://intra.glis.mnr.gov.on.ca/common/tag_colours/
#' for the full list of tag colour 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
#'
#' tag_colours <- get_tag_colours()
#' tag_colour_slugs <- get_tag_colours(show_id = TRUE)
get_tag_colours <- 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("tag_colours", filter_list, "common")
  # TODO: add a warning about 'all=TRUE' being the only allowed filter

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

  return(payload)
}