R/get_FN012_protocol.R

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

#' Get FN012_Protocol - Sampling specs (species and group) for a
#' specific lake and protocol from FN_Portal API
#'
#' This function accesses the api endpoint for FN012 Protocol List
#' records. These records are the expected range of biodata values
#' (e.g. FLEN, TLEN, RWT, K) for the typical species caught in using
#' a given protocol in a given lake. These constraints are used
#' by ProcVal to check that biodata for fish caught during the project is
#' reasonable. The protocol and lake MUST be specified for retrieving
#' records using this function. This is a useful function for building
#' a template database for a new project or for adding an FN012 table to
#' an existing project.
#'
#' Use \code{show_filters("fn012_protocol")} to see the full list of available filter
#' keys (query parameters). Refer to
#' \url{https://intra.glis.mnr.gov.on.ca/fn_portal/api/v1/swagger/}
#' and filter by "fn012_protocol" 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
#'
#' fn012_protocol <- get_FN012_Protocol(list(lake = "ON", protocol = "TWL"))
#'
#' fn012_protocol <- get_FN012_Protocol(list(lake = "HU", protocol = "BSM"))
#'
#' fn012_protocol <- get_FN012_Protocol(list(lake = "ER", protocol = "Hydro"))
get_FN012_Protocol <- 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("fn012_protocol", filter_list, "fn_portal")
  my_url <- sprintf(
    "%s/fn012_protocol/%s",
    get_fn_portal_root(),
    query_string
  )
  payload <- api_to_dataframe(my_url, recursive = recursive)
  payload <- prepare_payload(payload, show_id, to_upper)

  return(payload)
}