silv_summary: Calculates a bunch of forest metrics

In silviculture: Utility Functions for Forest Inventory and Silviculture

Calculates a bunch of forest metrics

Description

Summarize forest inventory data calculating most typical variables

Usage

silv_summary(
  data,
  diameter,
  height,
  plot_size,
  .groups = NULL,
  plot_shape = "circular",
  dmin = 7.5,
  dmax = NULL,
  class_length = 5,
  include_lowest = TRUE,
  which_h0 = "assman",
  which_spacing = "hart"
)

Arguments

data	A tibble of inventory data
diameter	A column with inventory diameters
height	A column with inventory heights
plot_size	The size of the plot. See silv_density_ntrees_ha()
.groups	A character vector with variables to group by (e.g. plot id, tree species, etc)
plot_shape	The shape of the sampling plot. Either circular or rectangular
dmin	The minimum inventory diameter in centimeters
dmax	The maximum inventory diameter in centimeters. Values that are greater than dmax are included in the greatest class
class_length	The length of the class in centimeters
include_lowest	Logical. If TRUE (the default), the intervals are ⁠[dim1, dim2)⁠. If FALSE, the intervals are ⁠(dim1, dim2]⁠ [dim1, dim2)⁠. If FALSE, the intervals are ⁠(dim1, dim2]: R:dim1,%20dim2)%60.%20If%20FALSE,%20the%20intervals%20are%20%60(dim1,%20dim2
which_h0	The method to calculate the dominant height. See silv_stand_dominant_height()
which_spacing	A character with the name of the index (either hart or hart-brecking). See silv_density_hart()

Details

The function calculates many inventory parameters and returns two tibbles:

• dclass_metrics: metrics summarized by .groups and diametric classes

• group_metrics: metrics summarized by .groups

Value

an S7 Inventory list with 2 tibbles

Examples

silv_summary(
  data      = inventory_samples,
  diameter  = diameter,
  height    = height,
  plot_size = 10,
  .groups   = c("plot_id", "species")
 )

silviculture documentation built on Nov. 5, 2025, 7:13 p.m.