R/describe_datasets.R

In jfjelstul/eulaw: An R Interface to the eulaw.app API

################################################################################
# Joshua C. Fjelstul, Ph.D.
# eulaw R package
################################################################################

#' Describes datasets in an eulaw.app database
#'
#' This function describes all of the datasets that are available from the
#' requested database.
#'
#' @param database The name of the database as a string. Use the function
#'   \code{list_databases()} to see a list of valid values.
#' @return A tibble with 3 columns.
#' @export
describe_datasets <- function(database) {
  url <- stringr::str_c("https://www.api.eulaw.app/databases/", database, "/datasets")
  out <- make_simple_request(url)
  out <- dplyr::select(out, dataset_id, dataset, label, description)
  return(out)
}

################################################################################
# end R script
################################################################################