Commit 59336cd1 authored by Luke Johnston's avatar Luke Johnston

Merge branch 'ros-checklist' into 'master'

ROS checklist to help guide our functions to build

See merge request !8
parents 7efc124d 10f5203a
Pipeline #111334566 failed with stage
in 5 minutes and 46 seconds
......@@ -4,6 +4,7 @@ Title: Heavily Opinionated Manifesto on Reproducible and Open Science Projects.
Version: 0.0.1.9000
Imports:
bookdown,
tinytex
tinytex,
kableExtra
Remotes: rstudio/bookdown
License: CCBY-4.0
......@@ -204,4 +204,25 @@ All current and future tools, services, and workflows incorporated into a
ROS project template must be based on these guiding principles and
considerations.
TODO: Include guiding principles for creating teaching material
TODO: Include guiding principles for creating teaching material?
## ROS principles as a checklist
Inspiration from [Software Sustainability Institute blog](https://www.software.ac.uk/blog/2018-05-22-sharing-reproducible-research-minimum-requirements-and-desirable-features),
[blog by Jonathan Peelle](https://thewinnower.com/papers/3706-a-manuscript-checklist-for-improving-science),
and from the [Transparency Checklist](https://www.nature.com/articles/s41562-019-0772-6)
(DOI: 10.1038/s41562-019-0772-6).
<!-- "Read more" in the column will contain links to where to read more about that item -->
```{r}
options(knitr.kable.NA = "")
library(kableExtra)
checklist <-
read.csv("resources/checklist.csv",
stringsAsFactors = FALSE,
check.names = FALSE)
knitr::kable(checklist, align = "l") %>%
kable_styling(c("striped", "hover"))
```
Item,Read more:,Done? (Y/N),Why not?
**Reproducibility**,,,
Indicate software dependencies,,,
Analysis code linked to open/simulated data,,,
Use standard project folder and file structure,,,
"Document (slides, poster, manuscript, etc) written reproducibly",,,
Provide explicit analysis steps taken,,,
Files under version control,,,
Code documented and explained,,,
Clearly label input and output data/results,,,
Follow code syntax style guide,,,
Run and pass spell checking,,,
Results reproduced on a clean computing environment,,,
Computing environment described,,,
List of all software tools used,,,
Data assertion checks (data passes expectations),,,
,,,
**Openness**,,,
"Make data publicly available, with DOI",,,
"Make data analysis (code) publicly available, with DOI",,,
Submit preprint,,,
"Pre-register study, with DOI",,,
"Pre-register analysis, with DOI",,,
License analysis code (MIT or similar),,,
License scientific content (CC-BY or similar),,,
Publish in open access journal,,,
"Make slides/poster publicly available, with DOI",,,
Manuscript contains all relevant URL/DOI,,,
Software and analysis methods used are open source,,,
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment