README.md

In ahart1/decisiontable: Make Customized Decision Tables

decisiontable

The goal of decisiontable is to combine text-based tables with graphical elements to produce flexible decision table visualizations that convey trade-offs and are easily reproduced. The package leverages bar plots, coloring options, layout choices, and optional summary information to highlight and display trade-offs.

Installation

You can install the development version of decisiontable from GitHub with:

# install.packages("devtools")
devtools::install_github("ahart1/decisiontable")

Usage

The makeDecisionTable() function is the powerhouse of this package. With it bar plots are used to visually display more traditional text information, coloring can be altered, figure dimensions and layout can be customized, and summary statistics can be calculated and appended to the resulting decision table figure.

Most simply, default function settings can be used to produce a decision table figure where bar chart height coresponds to the printed values along the x-axis of each plot and row and column labels are pulled from the input dataframe. Only the output file name, title, and row headers need be specified to produce an informative decision table. The figure will automatically be stored as a .png file in your current working directory.

library(decisiontable)

# Here is an example dataframe
set.seed(1)
data_df <- matrix(c(abs(rnorm(30,20,sd=5))), ncol = 5, nrow = 6)
colnames(data_df) <- c("Column 1", "Column 2", "Column 3", "Column 4", "Column 5")
rownames(data_df) <- c("Row 1", "Row 2", "Row 3", "Row 4", "Row 5", "Row 6")


# Produce a simple decision table figure using default formatting and minimal input
makeDecisionTable(data = data_df,
                  OutputFileName = "Readme_Fig2",
                  GraphicTitle = "Decision table with \n default formatting",
                  RowHeader = "Row header \n describes type \n of data in rows",
                  ColumnHeader = "Column header describes type of data in columns")
#> [1] "Empty Plot Icon"
#> [1] "Empty Plot Icon"
#> [1] "Empty Plot Icon"
#> [1] "You are done =)"
#> quartz_off_screen 
#>                 2

To get an introduction to other features of the package, read the introductory vignette.

vignette("decisiontable", package = "decisiontable")

ahart1/decisiontable documentation built on March 17, 2021, 4:18 a.m.