R/ojo_add_party_details.R

In openjusticeok/ojodb: Analyze Data from the Open Justice Oklahoma Database

#' Add party details to a parties query
#'
#' Query the Open Justice Oklahoma database for party details
#'
#' @param data A lazy tibble containing the results of a parties query
#' @param vars A character vector of variables to return
#' @param ... Placeholder for additional arguments
#'
#' @export ojo_add_party_details
#' @return data, a lazy tibble containing the resulting party details
#' @examples
#' \dontrun{
#' ojo_add_party_details()
#' }
#'
ojo_add_party_details <- function(data, vars = NULL, ...) {
  if (!inherits(data, "tbl_lazy")) {
    stop("Don't use `collect()` before this function")
  }

  columns <- colnames(data)

  if (!"party" %in% columns) {
    if ("parties" %in% columns) {
      if (inherits(data$parties, "pq__text")) {
        stop("You must first unnest the `parties` column")
      } else {
        stop("Make sure you unnested the `parties` column into a column named `party`")
      }
    }
    stop("Data must contain a column named `party`")
  }

  data <- data |>
    dplyr::left_join(ojo_tbl("person_record"), by = c("party" = "id"))

  return(data)
}