R/discussion_table.R

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

#' @title Discussion Table
#'
#' @description Creates a table of discussion items from the input discussion
#'   data frame.
#'
#' @param discussion_df     data.frame; A data frame of discussion items.
#' @param items             character; A vector of item ids to display
#'                          in the table.
#'
#' @return A kable table styled for reporting.
#' @export
#'
#'
#' @importFrom kableExtra kable_styling kbl column_spec
#' @importFrom dplyr select arrange mutate desc
#' @importFrom magrittr %>%
#' @importFrom lubridate as_date
#'
#' @examples
#' #Get test data
#' library(magrittr)
#' db_discussion <- rarr::db_discussion
#' discussion <- wrangle_discussion(db_discussion)
#'
#' x<-"ACT-006"
#' discussion_item <- discussion %>%
#'   dplyr::filter(TABLE_NAME == "ACTION_REGISTER") %>%
#'   dplyr::filter(fk_table_id == x)
#' #example
#' discussion_table<-discussion_table(discussion_item, discussion_item$fk_table_id)
#'
#'
discussion_table <- function(discussion_df, items) {
  # pre-process the data
  discussion_items <- discussion_df %>%
    select(.data$DISCUSSION, .data$RESPONSIBLE_POC, .data$poc_review_date) %>%
    arrange(desc(.data$poc_review_date)) %>%
    mutate(poc_review_date = as_date(.data$poc_review_date))

  col_names <- c("Discussion Topic", "POC", "Date")

  # Build the table
  discussion_table <- kbl(discussion_items,
                          col.names = col_names) %>%
    kable_styling(bootstrap_options = c("striped", "hover", "condensed",
                                        "responsive"),
                  full_width = TRUE,
                  position = "left",
                  font_size = 12) %>%
    column_spec(3, width = "6em")

  return(discussion_table)
}