.github/CONTRIBUTING.md

In vanNijnatten/Learn-Statistics: Dummy package that shows how statistical functions are made

Contributing to Learn-Statistics

This outlines how to propose a change to Learn-Statistics.

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file. If you want to fix typos in the documentation, please edit the related .R file in the R/ folder. Do not edit an .Rd file in man/.

Filing an issue

The easiest way to propose a change or new feature is to file an issue. If you've found a bug, you may also create an associated issue. If possible, try to illustrate your proposal or the bug with a minimal reproducible example.

Pull requests

• Please create a Git branch for each pull request (PR).
• Your contributed code should roughly follow the R style guide, but in particular our easystats convention of code-style.
• Learn-Statistics uses roxygen2, with Markdown syntax, for documentation.
• Learn-Statistics uses testthat. Adding tests to the PR makes it easier for me to merge your PR into the code base.
• If your PR is a user-visible change, you may add a bullet to the top of NEWS.md describing the changes made. You may optionally add your GitHub username, and links to relevant issue(s)/PR(s).

Code of Conduct

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

Note to developer

Tools

• Run devtools::create("myfirstpackage") to create an R package.
• Change the values in DESCRIPTION to your liking.
• Run usethis::use_ccby_license(name="Author Name") to add a license.
• Run usethis::use_pipe() to add the 'magnittr' pipe.
• Add 'assertthat' to the 'Imports' section of the 'DECRIPTION' file.
• Create an R file in the R directory and write functions in it. E.g. 'myStatistics.R'.
• Check the user input of the function using 'assertthat'.
• Run usethis::use_test('myStatistics') to create a test file.
• Alter the test function and add more tests.
• Run devtools::test().
• This will run devtools::load_all().
• Make sure all tests pass.
• You can see the code coverage of the tests by running covr::coverage_to_list() or covr::report() (70-100% is good).
• Run devtools::use_data(x) to store object x as a data object that is part of this package.
• Run usethis::use_vignette("introduction") to create a template vignette file.
• Run devtools::check() before doing a git commit and git push and solve any issues.
• This will run devtools::document() to generate documentation.
• Commit changes to the git repository and push them to GitHub.

URLs

• Good info on how to create packages is available at
• TinyHeero.GitHub.io and at
• r-pkgs.org.
• Make tests as written at
• r-pkgs.org and in its
• Automated checking section.
• Check all user inputs using assertthat.
• Follow the Defensive Programming Paradigm.

vanNijnatten/Learn-Statistics documentation built on Dec. 23, 2021, 2:09 p.m.