R package medfate and its associated R packages should be viewed as an ongoing research project for the development of forest ecosystem modelling tools. The medfate R package is the result of collaborative work between modellers and experts in different disciplines. Since successful modelling projects involve long-term investments and the participation of multiple teams, we are open to further expanding the set of people contributing to the project. Normally, contributors will start participating as model users, but may soon have their own ideas in how to improve the model or encounter some issues to be solved.
Contributions to the development of medfate can be done in different aspects:
SpParamsUS. Note that we are working on a companion package called medfateutils that should be helpful to define and populate new species parameter tables.
If you want to report a bug or suggest an enhancement, it’s a good idea to file an issue to the medfate repository at GitHub. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex.
Before making contributions to the package R or C++ code, make sure someone from the medfate team agrees that the change you suggest is needed.
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using
usethis::create_from_github("emf-creaf/medfate", fork = TRUE).
Install all development dependences with
devtools::install_dev_deps(), and then make sure the package passes R CMD check by running
devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.
Create a Git branch for your pull request (PR). We recommend using
Make your changes, commit to git, and then create a PR by running
usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain
For user-facing changes, add a bullet to the top of
NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.