BSkyFormat: BSkyFormat generates formatted output (text or table)

In BlueSkyStatistics/BlueSky: BlueSky Collection of Functions for Data Access, Analysis, and Formatting.

BSkyFormat generates formatted output (text or table)

Usage

BSkyFormat(
  obj,
  maxOutputTables = BSkyGetTableDisplayLimits(),
  outputTableIndex = c(),
  outputColumnIndex = c(),
  outputTableRenames = c(),
  outputColumnRenames = c(),
  outputColumnRenamesRow = c(),
  maxRowLimit = BSkyGetTableDisplayLimits(),
  maxColLimit = BSkyGetTableDisplayLimits(),
  silentFormatting = FALSE,
  bSkyFormatAppRequest = FALSE,
  bSkyReturnObj = TRUE,
  ftable_change_variable_order = TRUE,
  sublist_length = 3,
  remove_rows_with_zero_count = FALSE,
  no_row_column_headers = FALSE,
  decimalDigitsRounding = BSkyGetDecimalDigitSetting(),
  engNotationSetting = BSkyGetEngNotationSetting(),
  singleTableOutputHeader = "",
  repeatAllTableFooter = c(),
  perTableFooter = c(),
  isRound = BSkyGetRound(),
  coefConfInt = 0.95,
  pvalueDisplaySettings = BSkyGetPvalueDisplaySetting(),
  isKableOutput = TRUE,
  isLatexOutput = FALSE,
  isRmarkdownOutput = TRUE,
  isTextOutput = FALSE,
  getNonRenderedTables = FALSE,
  ignoreEnvStyleOverride = FALSE,
  forceColumnAlign = c(),
  kableStyleTheme = "kable_styling",
  textTableFormat = BSkyGetTextTableFormat(),
 
    tableStylingOptions = "table_border = F, column_align = r, header_background = \"#bdbdbd\" , more_options = c(bootstrap_options = c(\"striped\", \"hover\", \"condensed\", \"responsive\"), position = \"left\", full_width = F, html_font = \"Helvetica\", fixed_thead = list(enabled = T, background = \"#bdbdbd\"))",
  RM.SSP = TRUE,
  RM.SSPE = RM.SSP
)

Arguments

obj	is an object of type data.frame, matrix, list, text or BSkyReturnStructure object, that is to be formatted.
maxOutputTables	maximum tables to output if obj contains mulitple tables
outputTableIndex	the order in which output tables are printed
outputColumnIndex	the order of columns in the table
outputTableRenames	custom name assigned to the table
outputColumnRenames	custom column names for the columns in a table
outputColumnRenamesRow	custom row names
maxRowLimit	maximum row to show in the output table
maxColLimit	maximum columns to show in the output table
...	other advanced level parameters

Examples

df <-data.frame(A=c(1,2,3), B=c(4,5,6), C=c(6,7,8))
BSkyFormat(df)

BlueSkyStatistics/BlueSky documentation built on April 14, 2025, 7:39 a.m.