summary_table: HSI Model Summary Table.

View source: R/summary_table.R

summary_tableR Documentation

HSI Model Summary Table.

Description

Produces an HSI model summary table for the specified metric.

Usage

summary_table(
  summary_df,
  model_metric = c("hsi_", "acres_", "hu_"),
  polys,
  poly_field,
  caption,
  digits = 2
)

Arguments

summary_df

data.frame; A model summary data frame created by the summarize_models function.

model_metric

character; The model metric to be summarized from the summary_df. One of "hsi_", "acres_", or "hu_".

polys

sf; A sf polygon object.

poly_field

character; The polys field used to identify the summarization features.

caption

character; A caption for the table.

digits

numeric; Number of decimal places to round metric.

Value

A model summary data frame and a knitr::kable table object (is returned silently).


MVR-GIS/nybem documentation built on Feb. 9, 2023, 7:03 a.m.