create_output_table: Create human readable output from the comparison_df output

View source: R/fnsOutputs.R

create_output_tableR Documentation

Create human readable output from the comparison_df output

Description

Currently 'html' and 'xlsx' are supported

Usage

create_output_table(
  comparison_output,
  output_type = "html",
  file_name = NULL,
  limit = 100,
  color_scheme = c(addition = "#52854C", removal = "#FC4E07", unchanged_cell =
    "#999999", unchanged_row = "#293352"),
  headers = NULL,
  change_col_name = "chng_type",
  group_col_name = "grp"
)

Arguments

comparison_output

Output from the comparison Table functions

output_type

Type of comparison output. Defaults to 'html'

file_name

Where to write the output to. Default to NULL which output to the Rstudio viewer (not supported for 'xlsx')

limit

maximum number of rows to show in the diff. >1000 not recommended for HTML

color_scheme

What color scheme to use for the output. Should be a vector/list with named_elements. Default - c("addition" = "green", "removal" = "red", "unchanged_cell" = "gray", "unchanged_row" = "deepskyblue")

headers

A character vector of column names to be used in the table. Defaults to colnames.

change_col_name

Name of the change column to use in the table. Defaults to chng_type.

group_col_name

Name of the group column to be used in the table (if there are multiple grouping vars). Defaults to grp.


compareDF documentation built on Oct. 1, 2022, 9:06 a.m.