Documentation improvements#21
Merged
Merged
Conversation
…s-lists # Conflicts: # NAMESPACE # _pkgdown.yml
…ion with units and detailed tutorials
…antation examples to silv_predict_biomass
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This Pull Request standardizes documentation across the core forest metrics modules (
predict-height,predict-biomass,predict-carbon, andpredict-snfi-volume). It ensures precise unit reporting (diameter/dnm in cm, height in m, biomass/carbon in kg, and volume in dm³) and provides detailed, dataset-based tutorial examples for applying these functions directly to forest inventories.Additionally:
silv_predict_height()now defaults to the genericeq_hd_vazquez_veloso_2025("All the species")if no model is specified.silv_predict_biomass()to support root collar diameter (rcd) and biomass packing (bp) for young plantations (Menéndez 2022) when DBH/diameter is absent.plotgeneric's page via@rdname plotand aligned generic signature fields to prevent R CMD checkcodocmismatches.Verification
You can dynamically explore the help pages and verify the logic with the following executable R code: