R/decision_register_table.R

In MVR-GIS/rarr: Risk Analysis Report in R

#' @title Decision Register Table
#'
#' @description Produces a decision register table of the input decision
#'   data frame.
#'
#' @param decision   data frame; A data frame of decisions.
#'
#' @return A kable table styled for reporting.
#'
#' @examples
#' #Get test data
#' db_decision <- rarr::db_decision
#'
#' decision <- wrangle_decision(db_decision)
#'
#' #example
#' decision_register<-decision_register_table(decision)
#'
#' @importFrom magrittr %>%
#' @importFrom dplyr mutate select
#' @importFrom kableExtra kbl kable_styling column_spec
#'
#' @export
#'
decision_register_table <- function(decision) {
  dec_df <- decision %>%
    select(.data$decision_no_link, .data$DECISION, .data$APPROVAL_STATUS, .data$decision_date) %>%
    mutate(decision_date = as_date(.data$decision_date))

  # Create the unstyled kable
  decision_register <- kbl(dec_df,
                           col.names = c("Number", "Decision", "Approval",
                                         "Date")) %>%
    kable_styling(bootstrap_options = c("striped", "hover",
                                        "condensed", "responsive"),
                  font_size = 12)

  # Group rows if records exist
  if(length(dec_df$decision_no) >= 1) {
    decision_register <- decision_register %>%
      column_spec(1, width = "7em") %>%
      column_spec(4, width = "6em")
  }

  return(decision_register)
}