Estimates forest indicators for a given set of forest stands during a given set of dates of evaluation.
Usage
estimate_indicators(
indicators,
stand_static_input = NULL,
stand_dynamic_input = NULL,
plant_static_input = NULL,
plant_dynamic_input = NULL,
timber_volume_function = NULL,
plant_biomass_function = NULL,
additional_params = list(),
verbose = TRUE
)
Arguments
- indicators
A character vector containing the indicators to be estimated.
- stand_static_input
A data frame (or
sf
object) containing static stand variables. Minimum required column areid_stand
(character).- stand_dynamic_input
Optional data frame containing dynamic stand variables. Minimum required columns are
id_stand
(character) anddate
(Date
).- plant_static_input
Optional data frame containing static plant variables. Minimum required columns are
id_stand
(character) andplant_entity
(character).- plant_dynamic_input
Optional data frame containing dynamic plant variables. Minimum required columns are
id_stand
(character),plant_entity
(character) anddate
(Date
).- timber_volume_function
Optional function supplied for timber volume calculation.
- plant_biomass_function
Optional function supplied for whole-plant biomass calculation.
- additional_params
Optional named list where each element is in turn a list of additional parameters required for internal indicator functions. The additional parameters of each indicator are found in table
additional_parameters
.- verbose
A logical flag to provide information on progress
Value
A data frame with the following columns:
id_stand
- Stand identifier.date
- Date of indicator assessment....
- Additional columns with names equal to strings given inindicators
.
Examples
## Use functions show_information() and available_indicators() to learn
## the requested inputs
## Named lists with additional parameters needed for each indicator
add_params <- list(timber_harvest = list(province = 8),
density_dead_wood = list(max_tree_dbh = 20))
## Call indicator estimation
estimate_indicators(c("basal_area", "timber_harvest", "density_dead_wood"),
plant_dynamic_input = example_plant_dynamic_input,
timber_volume_function = forestindicators:::.ifn_volume_forestindicators,
additional_params = add_params,
verbose = TRUE)
#> ℹ Checking overall inputs
#> ℹ Checking inputs for 'basal_area'.
#> ✔ Checking inputs for 'basal_area'. [5ms]
#>
#> ℹ Checking overall inputs
#> ✔ Checking overall inputs [17ms]
#>
#> ℹ Processing 'basal_area'.
#> ℹ Checking inputs for 'timber_harvest'.
#> ✔ Checking inputs for 'timber_harvest'. [5ms]
#>
#> ℹ Processing 'basal_area'.
#> ✔ Processing 'basal_area'. [48ms]
#>
#> ℹ Processing 'timber_harvest'.
#> ℹ Checking inputs for 'density_dead_wood'.
#> ✔ Checking inputs for 'density_dead_wood'. [6ms]
#>
#> ℹ Processing 'timber_harvest'.
#> ✔ Processing 'timber_harvest'. [90ms]
#>
#> ℹ Processing 'density_dead_wood'.
#> ✔ Processing 'density_dead_wood'. [17ms]
#>
#> # A tibble: 6 × 5
#> id_stand date basal_area timber_harvest density_dead_wood
#> <chr> <date> <dbl> <dbl> <dbl>
#> 1 080001 2025-01-01 306. 51.9 187
#> 2 080001 2025-02-01 292. 29.2 73
#> 3 080001 2025-03-01 226. 25.6 NA
#> 4 080005 2025-01-01 79.3 34.4 NA
#> 5 080005 2025-02-01 171. 6.98 22
#> 6 080005 2025-03-01 151. 11.3 17