Skip to contents

Produces an HSI model summary table for the specified metric.

Usage

summary_table(
  summary_df,
  model_metric = c("hu_", "acres_"),
  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 "hu_" or "acres_".

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).