ff_pretty_kable: Pretty formatting of significance testing and estimate tables...

View source: R/analysis.R

ff_pretty_kableR Documentation

Pretty formatting of significance testing and estimate tables with Kable

Description

This function elegantly formats significance testing matrices produces by 'ff_sigtest' or estimate matrices produced by 'ff_estimates_ci'. It bolds cells that are statistically significant (for significance testing matrices), only keeps rows for Forsyth County, and makes other minor stylistic changes.

Usage

ff_pretty_kable(
  data_matrix,
  table_type,
  format = "continuous",
  table_name = NULL
)

Arguments

data_matrix

A matrix produced by 'ff_sigtest' or 'ff_estimates_ci'.

table_type

Either 'sigtest' or 'estimate'. Specifies whether the table was generated by 'ff_sigtest' and has results from a significance test; or whether the table was generated by 'ff_estimates_ci' and has estimates and confidence intervals.

format

Type of data; either 'continuous' or 'binomial'. Defaults to 'continuous'.

table_name

A string of characters representing the table name. It is displayed above the table. Defautls to no table name.

Value

An html-based Kable table.


forsythfuture/FFtools documentation built on April 5, 2022, 10:02 p.m.