R/list_data_sources.R

In EDIutils: An API Client for the Environmental Data Initiative Repository

#' List data sources
#'
#' @description Data sources are data packages, or other online digital
#' objects, that are known to be inputs to the specified derived data package.
#'
#' @param packageId (character) Data package identifier
#' @param as (character) Format of the returned object. Can be: "data.frame" 
#' or "xml".
#' @param env (character) Repository environment. Can be: "production",
#' "staging", or "development".
#'
#' @return (data.frame or xml_document) Data sources to \code{packageId}
#'
#' @details Data sources can be either internal or external to the EDI data
#' repository. Internal data sources include a packageId value and a URL to the
#' source metadata. For data sources external to PASTA, the packageId element
#' will be empty and a URL value may or not be documented.
#' 
#' @family Listing
#'
#' @export
#'
#' @examples
#' \dontrun{
#' 
#' # List sources
#' dataSources <- list_data_sources("edi.275.4")
#' }
list_data_sources <- function(packageId, 
                              as = "data.frame", 
                              env = "production") {
  url <- paste0(
    base_url(env), "/package/sources/eml/",
    paste(parse_packageId(packageId), collapse = "/")
  )
  resp <- httr::GET(url, set_user_agent(), handle = httr::handle(""))
  res <- httr::content(resp, as = "text", encoding = "UTF-8")
  httr::stop_for_status(resp, res)
  res <- xml2::read_xml(res)
  ifelse(as == "data.frame", return(xml2df(res)), return(res))
}