R/extract-meta.R

In q-w-a/regulationsgov: Accessing Regulations.gov Data

utils::globalVariables(".")

#' Extract Metadata for Specific Documents or Comments
#'
#' @param link a link of the form https://api.regulations.gov/v4/comments/COMMENT_ID_HERE for
#' the comment endpoint or a link of the form https://api.regulations.gov/v4/comments/DOCUMENT_ID_HERE
#' for the document endpoint. Detailed information will be obtained on the document or comment of the
#' given ID.
#' @param key the API key passed in the function call; this may be NULL if the user has
#'   chosen to set up the key as an environmental variable instead with the function
#'   \code{\link{set_datagov_key}}. You can use "DEMO_KEY" for a very limited number of calls if needed.
#' @return a data frame containing the metadata for the comment or document ID, including, if present
#'   the attachment links.
#' @importFrom rlang .data
#' @importFrom dplyr select contains across everything rename_with mutate
#' @keywords internal
#' @examples
#' \dontrun{
#' # get comment metadata for a specific comment
#' result_comment <- extract_meta("https://api.regulations.gov/v4/comments/NOAA-NMFS-2013-0095-0007")
#' # get comment metadata for a specific document
#' result_doc <- extract_meta("https://api.regulations.gov/v4/documents/NIH-2006-0048-0001")
#' }
extract_meta <- function(link, key = NULL) {
  key <- check_auth(key)

  api_link <- paste0(link, "?include=attachments&api_key=", key)
  parsed <- get_data(api_link)


  comment_meta_df <- parsed %>%
    unlist(recursive = TRUE) %>%
    t() %>%
    as.data.frame()

  # fix duplicated names
  names(comment_meta_df) <- make.names(names(comment_meta_df),
    unique = TRUE
  )

  tryCatch(
    {
      comment_meta_df <- comment_meta_df %>%
        mutate(dplyr::across(
          dplyr::everything(),
          ~ paste0(unlist(.x),
            collapse = ","
          )
        )) %>%
        mutate(fileUrl = paste0(
          select(., contains("fileUrl")),
          collapse = ","
        )) %>%
        select(-dplyr::matches("fileUrl[[:digit:]]|fileUrl\\.[[:digit:]]|\\.fileUrl")) %>%
        select(-which(dplyr::all_of(.) == "")) %>%
        select(!dplyr::contains("display")) %>%
        rename_with(~ gsub(
          "fileFormats\\.|attributes\\.|included\\.",
          "", .x
        )) %>%
        rename_with(~ gsub(".", "_", .x,
          fixed = TRUE
        ))
    },
    error = function(e) {
      message("error with", api_link)
      return(parsed)
    }
  )
  # add ID
  # comment_meta_df$cid <- parsed$data$id

  # return data frame of metadata for a single comment ID
  return(comment_meta_df)
}