-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
647 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
title: "Collaboration workflow" | ||
include-in-header: | ||
- text: | | ||
<style> | ||
.vertical-center { | ||
display: flex; | ||
justify-content: center; | ||
align-items: center; | ||
} | ||
</style> | ||
format: | ||
html: | ||
page-layout: full | ||
--- | ||
|
||
This document presents the phases of the SwissStatsR collaboration workflow. | ||
|
||
![](images/collaboration-workflow.png) | ||
|
||
::: {.vertical-center} | ||
[Click here to make a submission](https://airtable.com/appTkja7O6oOv6zZ8/pagrVmrt4pUqqKLX6/form){.btn .btn-outline-primary .btn role="button"} | ||
::: | ||
|
||
## 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](https://airtable.com/appTkja7O6oOv6zZ8/pagrVmrt4pUqqKLX6/form) or by [email](https://swissstatsr.org/about.html). | ||
|
||
## 2. GitHub Private | ||
|
||
- Once [your submission](https://airtable.com/appTkja7O6oOv6zZ8/pagrVmrt4pUqqKLX6/form) is accepted, peer reviewing starts with SwissStatsR members. | ||
- You should have an account on [GitHub](https://github.com/). | ||
- Hosting on our [SwissStatsR GitHub](https://github.com/SwissStatsR) is recommended but not mandatory. | ||
|
||
## 3. GitHub Public | ||
|
||
[^1]: The use of GitHub is recommended to ease collaboration and leverage R-CMD-Check GitHub Actions. | ||
|
||
- SwissStatsR public release of R code is only possible as an open-source [R package](https://r-pkgs.org/). | ||
- The R package can be hosted on any GitHub repository, including [SwissStatsR GitHub](https://github.com/SwissStatsR), or another DevOps public provider[^1]. | ||
- The R package should have an GitHub Action [R-CMD-Check](https://r-pkgs.org/R-CMD-check.html) badge: | ||
- [`usethis::use_github_action()`](https://usethis.r-lib.org/reference/github_actions.html) | ||
- The R package should have an [open source license](https://r-pkgs.org/license.html) such as MIT, GPL or LGPL: | ||
- for example: [`usethis::use_gpl3_license()`](https://usethis.r-lib.org/reference/licenses.html) | ||
|
||
## 4. R-Universe | ||
|
||
- The open source R package should pass [R-CMD-Check](https://r-pkgs.org/R-CMD-check.html). | ||
- It should also be [well documented](https://r-pkgs.org/man.html). | ||
- [Unit tests](https://r-pkgs.org/testing-basics.html) are recommended but not mandatory. | ||
- Adding a [SwissStatsR badge](https://swissstatsr.r-universe.dev/badges) is optional. | ||
|
||
## 5. SwissStatsR.org | ||
|
||
- Once the R package hits the [SwissStatsR Universe](https://swissstatsr.r-universe.dev/), it will be added on [SwissStatsR.org](https://swissstatsr.org/). | ||
|
||
## 6. Promotion (optional) | ||
|
||
- You can write an article about your R package on [our blog](https://swissstatsr.substack.com/). | ||
- Subscribe to our blog [here](https://swissstatsr.substack.com/). | ||
|
||
Contact information can be found in the [About](https://swissstatsr.org/about.html) section. | ||
|
||
::: {.vertical-center} | ||
[Click here to make a submission](https://airtable.com/appTkja7O6oOv6zZ8/pagrVmrt4pUqqKLX6/form){.btn .btn-outline-primary .btn role="button"} | ||
::: |
This file contains 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
Oops, something went wrong.