Collaboration workflow

This document presents the phases of the SwissStatsR collaboration workflow.

Click here to make a submission

1. Your Code

• Any R script can be submitted to SwissStatsR.
• Our only requirement is to be related to Swiss Statistics.
• Make a submission using the form or by email.

2. GitHub Private

• Once your submission is accepted, peer reviewing starts with SwissStatsR members.
• You should have an account on GitHub.
• Hosting on our SwissStatsR GitHub is recommended but not mandatory.

3. GitHub Public

• SwissStatsR public release of R code is only possible as an open-source R package.
• The R package can be hosted on any GitHub repository, including SwissStatsR GitHub, or another DevOps public provider¹.
• The R package should have an GitHub Action R-CMD-Check badge:
  • usethis::use_github_action()
• The R package should have an open source license such as MIT, GPL or LGPL:
  • for example: usethis::use_gpl3_license()

4. R-Universe

• The open source R package should pass R-CMD-Check.
• It should also be well documented.
• Unit tests are recommended but not mandatory.
• Adding a SwissStatsR badge is optional.

5. SwissStatsR.org

• Once the R package hits the SwissStatsR Universe, it will be added on SwissStatsR.org.

6. Promotion (optional)

• You can write an article about your R package on our blog.
• Subscribe to our blog here.

Contact information can be found in the About section.

Click here to make a submission

Footnotes

1. The use of GitHub is recommended to ease collaboration and leverage R-CMD-Check GitHub Actions.