Describe an individual indicator

Prompts information in to the console regarding the definition, units and data requirements for a given forest indicator.

Usage

show_information(indicator)

Arguments

indicator

Character string of the indicator to be described.

Value

The function returns console output only.

See also

available_indicators, estimate_indicators

Examples

show_information("timber_harvest")
#> A) DEFINITION
#> 
#>    Name:  timber_harvest 
#>    Estimation:  NA 
#>    Interpretation:  Volume over bark of harvested wood 
#>    Output units:  NA 
#> 
#> 
#> B) DATA INPUTS
#> 
#> B.1) Stand-level static data: <NONE>
#> B.2) Stand-level dynamic data: <NONE>
#> B.3) Plant-level static data: <NONE>
#> B.4) Plant-level dynamic data:
#> 
#>  variable      type   units
#>       dbh   numeric      cm
#>         h   numeric       m
#>         n   numeric ind./ha
#>     state character       -
#>                                                    description
#>                                      diameter at breast height
#>                                                         height
#>                                                        density
#>  state of the cohort, tree, … can be 'live', 'cut', or 'death'
#> 
#> 
#> C) ADDITIONAL PARAMETERS
#> 
#>         parameter default_value
#>          province          <NA>
#>      min_tree_dbh          <NA>
#>      max_tree_dbh          <NA>
#>  targeted_species          <NA>
#>  excluded_species          <NA>
#>                                                                           description
#>                                                       Spanish province (numeric code)
#>             Minimum  tree diameter to be included in the estimation of harvest volume
#>  Maximum  tree diameter to be included in the estimation of density of harvest volume
#>                          Tree species included in the calculation of harvested volume
#>                      Tree species not included in the calculation of harvested volume
#> 
#>