Contributing to tidyhydro • tidyhydro

This outlines how to propose a change to tidyhydro. For a detailed discussion on contributing to this and other packages, please see the development contributing guide and our code review principles.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed). See our guide on how to create a great issue for more advice.

Pull request process

Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("atsyplenkov/tidyhydro", fork = TRUE).
Install all development dependencies 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 usethis::pr_init("brief-description-of-change").
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 Fixes #issue-number.
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.

Code style

New code should follow the tidyverse style guide and use air for formatting. Please don’t restyle code that has nothing to do with your PR.
We use roxygen2, with Markdown syntax, for documentation.
We use testthat for unit tests and quickcheck for property-based testing (see this blogpost for details).

C++

The package uses a lot of C++ code via the Rcpp package. Therefore, it is expected that every new function has a C++ implementation. After adding new C++ code, do not forget to compile attributes with Rcpp::compileAttributes() and rebuild documentation with devtools::document(). The NAMESPACE file should be updated manually.

Code of Conduct

Please note that the tidyhydro project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

Roadmap

GOF

-[ ] KGE’’

-[ ] KGE Score

Regression

-[ ] PPCC - maximizes the probability plot correlation coefficient [@helselStatisticalMethodsWater2002, p.253]

-[ ] SSE - minimize sum of square errors [@helselStatisticalMethodsWater2002, p.253]

-[ ] BCF - Duan’s bias correction factor for log, log10 and log2 [@rasmussenGuidelinesProceduresComputing2009, p. 17]

-[ ] MSPE - model standard percentage error log and nonlog [@rasmussenGuidelinesProceduresComputing2009, p. 13]

-[ ] RMSE