Skip to content

Commit 4deea94

Browse files
authored
Merge pull request #74 from UN-Task-Team-for-Scanner-Data/how-to-start-amendment-1
Change in wording of how-to-start
2 parents efe8c1d + 17f42b8 commit 4deea94

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/reproducibility-guidance/how-to-start.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ Although this may feel like a foray away from research and into software develop
6161

6262
## Checklist
6363

64-
Rather than a strictly-defined list of requirements, this is intended to provide suggestions for how you can improve your project with RAP principles. You're encouraged to consider the objective of your work and then determine which suggestions best support those objectives.
64+
Rather than a strictly-defined list of requirements, this list is intended to provide a checklist of suggestions for how you can improve your project with RAP principles. You're encouraged to consider the objective of your work and then determine which suggestions best support those objectives. Remember that any effort to make a paper replicable, however small, can turn an interesting paper and a vital reference tool for future researchers.
6565

6666
### Baseline
6767

6868
- [ ] Make the code available online. GitHub is free and considered the best option, but using an institution's website, or even a public blog, is better than nothing.
6969

7070
- [ ] Use a widely-accepted language, ideally an open-source one. R and Python are both free and widely used, and using a commonly-understood language makes the code more accessible.
7171

72-
- [ ] Make input data available online when possible. Zenodo is a free-to-use option. You can also use existing open datasets if you don't want to go through the hastle of making your data availible.
72+
- [ ] Make input data available online when possible. Zenodo is a free-to-use option. You can also use existing open datasets if you can't or don't wish to go through the process of making your data availible.
7373

7474
- [ ] Make documentation explaining the code and data available online. These should be sufficient for a user to repeat the analysis.
7575

@@ -93,4 +93,4 @@ Rather than a strictly-defined list of requirements, this is intended to provide
9393

9494
- [ ] The explanatory documentation covers major changes over time (e.g., Semantic Versioning).
9595

96-
- [ ] The project is automated end-to-end, including the writeup of the paper published alongside the code. In essense, it is clear how each figure and table in the paper was generated.
96+
- [ ] The project is automated end-to-end, including the writeup of the paper published alongside the code. In essense, it is clear how each figure and table in the paper was generated.

0 commit comments

Comments
 (0)