forked from cjvanlissa/worcs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
91 lines (66 loc) · 5.4 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
---
output: github_document
---
# WORCS <a href='https://osf.io/zcvbs/'><img src='https://github.com/cjvanlissa/worcs/raw/master/docs/worcs_icon.png' align="right" height="139" /></a>
<!-- README.md is generated from README.Rmd. Please edit that file -->
<!--[](https://cran.r-project.org/package=worcs)
[](https://cran.r-project.org/package=worcs)-->
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://travis-ci.org/cjvanlissa/worcs)
[](https://bestpractices.coreinfrastructure.org/projects/3969)
[](https://CRAN.R-project.org/package=worcs)
[](https://cran.r-project.org/package=worcs)
<!--[](https://codecov.io/gh/cjvanlissa/worcs?branch=master)-->
<!--[](https://doi.org/10.21105/joss.00978)-->
The Workflow for Open Reproducible Code in Science (WORCS) is an easy to adopt approach to ensuring a research project meets the requirements of Open Science from the start. It is based on a "good enough" philosophy, prioritizing user-friendliness over exhaustiveness. It can be used either in absence of, or in parallel to, existing requirements for Open workflows. It can also be enhanced with more elaborate solutions for specific issues.
## Where do I start?
For most users, the recommended starting point is to read [the preprint paper, available on the Open Science Framework](https://osf.io/zcvbs/).
The paper describes the WORCS workflow, and how the `worcs` package fits into that workflow.
## About this repository
This repository contains the following:
1. An R-package called `worcs`, with convenience functions to facilitate the WORCS workflow.
2. In the subfolder `./paper`, the source files for the paper describing the WORCS workflow.
The repository serves two functions: To allow users to install the `worcs` package, and to allow collaborators access to the source code for the package and paper.
## Repository structure
```{r echo = FALSE, results = "asis"}
descripts <- data.frame(matrix(c(
"_pkgdown.yml", "YAML for package website", "do not edit",
"DESCRIPTION", "R-package DESCRIPTION", "do not edit",
"LICENSE.md", "Project license", "do not edit",
"NAMESPACE", "R-package namespace", "machine-written",
"README.md", "Read this file to get started! ", "do not edit",
"README.Rmd", "R-markdown source for readme.md", "human editable",
"worcs.Rproj", "RStudio project file", "do not edit",
"docs/", "Package website", "machine-written",
"inst/", "RStudio project template files ", "human editable",
"man/", "R-package documentation", "do not edit",
"paper/", "WORCS paper source files", "human editable",
"R/", "R-package source code", "human editable",
"vignettes/", "R-package vignettes", "human editable"
), ncol = 3, byrow = TRUE))
names(descripts) <- c("File", "Description", "Usage")
knitr::kable(descripts)
```
## Installing the package
Before installing the package, please read [this vignette](https://cjvanlissa.github.io/worcs/articles/setup.html), which explains how to set up your computer for `worcs`.
After reading [the vignette](https://cjvanlissa.github.io/worcs/articles/setup.html), you can install the development version of the `worcs` package from GitHub with:
``` r
if(!requireNamespace("remotes"))install.packages("remotes")
remotes::install_github("cjvanlissa/worcs", dependencies = TRUE, update = "never")
remotes::install_github("crsh/papaja", dependencies = TRUE, update = "never")
tinytex::install_tinytex()
worcs::git_user("your_name", "your_email")
```
## Citing WORCS
You can cite WORCS using the following citation (please use the same citation for either the package, or the paper):
> Van Lissa, C. J. (2020, February 11). WORCS: A Workflow for Open Reproducible Code in Science. https://doi.org/10.17605/OSF.IO/ZCVBS
## Contributing and Contact Information
The WORCS paper and `worcs` package are open to contributions from collaborators with valuable expertise, to improve both the workflow and the package. Relevant contributions warrant coauthorship to the paper or package. Please contact the lead author at [[email protected]](mailto:[email protected]), or:
- File a GitHub issue [here](https://github.com/cjvanlissa/worcs)
- Make a pull request
[here](https://github.com/cjvanlissa/worcs/pulls)
By participating in this project, you agree to abide by the [Contributor
Code of Conduct v2.0](https://www.contributor-covenant.org/). Contributions to the package must adhere to the [tidyverse style guide](https://style.tidyverse.org/). When contributing code, please add tests for that contribution to the `tests/testthat` folder, and ensure that these tests pass on [Travis-CI](https://travis-ci.org/github/cjvanlissa/worcs).
## Acknowledgements
The worcs logo is inspired by the Open Science Badges by the Center for Open Science (CC-BY-4.0), and makes use of the gear, services, gears, preferences, settings icon, made by MD Badsha Meah from www.freeicons.io (CC-BY-3.0).