R/get_FN121.R

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

#' Get FN121 - Net set data from FN_Portal API
#'
#' This function accesses the api endpoint to for FN121
#' records. FN121 records contain information about net sets or more
#' generally sampling events in OMNR netting projects.  The FN121
#' records contain information like set and lift date and time, effort
#' duration, gear, site depth and location.  This function takes an
#' optional filter list which can be used to return record based on
#' several attributes of the net set including set and lift date and
#' time, effort duration, gear, site depth and location as well as
#' attributes of the projects they are associated with such project
#' code, or part of the project code, lake, first year, last year,
#' protocol, etc.
#'
#' Use \code{show_filters1("fn121")} 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 "fn121" 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
#'
#' fn121 <- get_FN121(list(lake = "ON", year = 2012))
#' fn121 <- get_FN121(list(
#'   lake = "ER", protocol = "TWL",
#'   sidep0__lte = 20, year__gte = 2010
#' ))
#' filters <- list(
#'   lake = "SU",
#'   prj_cd = c("LSA_IA15_CIN", "LSA_IA17_CIN")
#' )
#' fn121 <- get_FN121(filters)
#' fn121 <- get_FN121(list(lake = "HU", prj_cd__like = "_003"))
#' fn121 <- get_FN121(list(lake = "HU", prj_cd__like = "_003"), show_id = TRUE)
get_FN121 <- 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("fn121", filter_list, "fn_portal")
  my_url <- sprintf(
    "%s/fn121/%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)
}