Summarize habitat suitability for SRH-2D results

vector_summarize_hsi(mesh_tbl, hsi_tbl, .group_var = comid, .id_var = vid)

Arguments

mesh_tbl

A tbl_df with one row per vertex, containing group IDs and mesh cell areas, as created with vector_prep_mesh()

hsi_tbl

A tbl_df with one row per vertex per flow, containing depths, velocities, and habitat suitability indices, as created with vector_calculate_hsi()

.group_var

The unquoted name of the attribute used to identify groups in the group_polygons layer. Defaults to comid

.id_var

The unquoted name of the attribute used to identify vertices in the mesh layer. Defaults to vid

Value

A tbl_df data frame with one row per group (comid) per flow (flow_cfs), containing the total inundated area (area_tot) in square feet, the suitable habitat area (area_wua) in square feet, and the ratio of suitable to total area (area_pct).