Format EJAM tabular outputs for saving as Excel spreadsheet

Used by table_xls_from_ejam(), and see ejam2excel()

Usage

table_xls_format(
  overall,
  formatted = NULL,
  eachsite,
  bybg = NULL,
  longnames = NULL,
  saveas = NULL,
  overwrite = TRUE,
  launchexcel = FALSE,
  testing = FALSE,
  updateProgress = NULL,
  analysis_title = "EJAM analysis",
  sitetype = NULL,
  radius_or_buffer_in_miles = NULL,
  radius_or_buffer_description =
    "Miles radius of circular buffer (or distance used if buffering around polygons)",
  buffer_desc = "Selected Locations",
  reports = global_or_param("default_reports"),
  ok2plot = TRUE,
  report_plot = NULL,
  plot_distance_by_group = FALSE,
  plotlatest = FALSE,
  plotfilename = NULL,
  mapadd = FALSE,
  report_map = NULL,
  community_reportadd = FALSE,
  community_html = NULL,
  heatmap_colnames = NULL,
  heatmap_cuts = c(80, 90, 95),
  heatmap_colors = c("yellow", "orange", "red"),
  heatmap2_colnames = NULL,
  heatmap2_cuts = c(1.05, 2, 3),
  heatmap2_colors = c("yellow", "orange", "red"),
  graycolnames = NULL,
  graycolor = "gray",
  narrowcolnames = NULL,
  narrow6 = 6,
  notes = NULL,
  custom_tab = NULL,
  custom_tab_name = "other",
  ejscreen_ejam_caveat = NULL,
  flagged_areas_tab = NULL,
  flagged_areas_tab_name = "Area Features",
  ...
)

Arguments

overall: table to save in one tab, from ejamit()$results_overall, EJAM analysis of indicators overall (one row), but if entire output of ejamit() is passed as if it were overall, function figures out eachsite, etc.
formatted: optional table to save in one tab, from ejamit()$results_overall, EJAM analysis overall in different format
eachsite: table to save in one tab, from ejamit()$results_bysite, EJAM analysis site by site (one row per site)
bybg: Optional large table of details of each blockgroup that is only needed to analyze distances by group.
longnames: vector of indicator names to display in Excel table
saveas: If not NULL, and a valid path with filename.xlsx is provided, the workbook will be saved locally at that path and name unless overwrite=FALSE.
overwrite: optional whether to save even if existing file path already has a file
launchexcel: Set to TRUE to have this function launch Excel immediately, showing the final workbook created here.
testing: optional for testing only
updateProgress: optional Shiny progress bar to update during formatting
analysis_title: optional title passed from Shiny app to 'Notes' sheet
sitetype: normally would be like ejamit()$sitetype
radius_or_buffer_in_miles: If provided, miles buffer distance (from polygon or from point if circular buffers)
radius_or_buffer_description: optional text saying if distance is radius or polygon buffer, passed to 'Notes' sheet
buffer_desc: optional description of buffer used in analysis, passed to 'Notes' sheet
reports: info about which columns to treat as URLs that should be hyperlinks - see url_columns_bysite
ok2plot: can set to FALSE to prevent plots from being attempted, while debugging
report_plot: optional plot object passed from EJAM shiny app to save in 'Plot' sheet of Excel table
plot_distance_by_group: logical, whether to try to add a plot of mean distance by group. This requires that bybg be provided as a parameter input to this function.
plotlatest: optional logical. If TRUE, the most recently displayed plot (prior to this function being called) will be inserted into a tab called plot2
plotfilename: the full path including name of .png file to insert
mapadd: optional logical, whether to add a tab with a map of the sites. If report tab is added, though, standalone static map in excel tab is redundant.
report_map: leaflet map object passed from Shiny app to display in 'Map' sheet
community_reportadd: Logical, whether to add a tab with a static copy of the summary report (tables, map, barplot).
community_html: HTML file of community report provided by shiny app to include in spreadsheet
heatmap_colnames: optional vector of colnames to apply heatmap colors, defaults to percentiles
heatmap_cuts: vector of values to separate heatmap colors, between 0-100 for percentiles
heatmap_colors: vector of color names for heatmap bins, same length as heatmap_cuts, where first color is for those >= 1st cutpoint, but <2d, second color is for those >=2d cutpoint but <3d, etc.
heatmap2_colnames: like heatmap_colnames but for ratios by default
heatmap2_cuts: like heatmap_cuts but for ratios by default
heatmap2_colors: like heatmap_colors but for ratios
graycolnames: which columns to de-emphasize
graycolor: color used to de-emphasize some columns
narrowcolnames: which column numbers to make narrow
narrow6: how narrow
notes: Text of additional notes to put in the notes tab, optional vector of character elements pasted in as one line each.
custom_tab: optional table to put in an extra tab
custom_tab_name: optional name of optional custom_tab
ejscreen_ejam_caveat: optional text if you want to change this in the notes tab
flagged_areas_tab: optional data.frame like ejamit()$results_summarized$flagged_areas (see calc_flagged_areas()) to put in an extra tab, showing the percent of analyzed residents with each feature or area type in their blockgroup, vs the US and State averages, with the ratio columns color-coded using heatmap2_cuts and heatmap2_colors. If the whole ejamit() output is passed as the overall parameter, this is extracted automatically. NULL omits the tab.
flagged_areas_tab_name: name of the tab for flagged_areas_tab
...: unused

Value

a workbook, ready to be saved in spreadsheet format, with tabs like "Overall" and "Each Site"

Examples

if (FALSE) { # \dontrun{
  EJAM:::table_xls_format(
    overall = testoutput_ejamit_100pts_1miles$results_overall,
    eachsite = testoutput_ejamit_100pts_1miles$results_bysite,
    saveas = tempfile(fileext = ".xlsx"))
 # can just pass the whole results of ejamit(), for convenience
 wb <- EJAM:::table_xls_format(testoutput_ejamit_100pts_1miles)
 openxlsx::saveWorkbook(wb, file = tempfile(fileext = ".xlsx"), overwrite = TRUE)
} # }

Format EJAM tabular outputs for saving as Excel spreadsheet

Usage

Arguments

Value

See also

Examples