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 paper, published in Data Science, which introduces the WORCS workflow, explains the underlying tools, and illustrates how the worcs package can be used to create a new project that follows the workflow.

The workflow is illustrated below; the workflow vignette describes each step in detail.

Installing the package

Before installing the package, please read this vignette, which explains how to set up your computer for worcs.

After reading the vignette, you can install the development version of the worcs package from GitHub with:

if(!requireNamespace("remotes"))install.packages("remotes")
remotes::install_github("cjvanlissa/worcs", dependencies = TRUE, update = "never")
tinytex::install_tinytex()
worcs::git_user("your_name", "your_email")

If you intend to write APA style manuscripts, you can additionally install the papaja package:

remotes::install_github("crsh/papaja", dependencies = TRUE, update = "never")

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., Brandmaier, A. M., Brinkman, L., Lamprecht, A., Peikert, A., , Struiksma, M. E., & Vreede, B. (in press). WORCS: A Workflow for Open Reproducible Code in Science. Data Science, 2021. Data Science, vol. 4, no. 1, pp. 29-49. DOI: 10.3233/DS-210031.

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

File Description Usage
_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

Adoption of WORCS by users

As of 2021-11-17, these are indicators of the adoption of worcs by users:

  1. The preprint has been downloaded 1372 times, since being published on 31-05-2020
  2. The paper in Data Science has been cited 13 times
  3. The worcs R-package has been downloaded 8350 times from CRAN, since being published on 18-05-2020
  4. The GitHub project has been forked 9 times, watched 5 times, and starred 54 times
  5. The lead author has given invited lecturegs on WORCS at:
    • One Health PACT (2021)
    • Max-Planck-Institute for Human Development (2020)
    • Open Science Community Rotterdam (2020)
    • Eindhoven University of Technology (2020)
  6. WORCS is currently used in the following public itHub repositories (sorted by user):

Contributing and Contact Information

We are always eager to receive user feedback and contributions to help us improve both the workflow and the software. Major contributions warrant coauthorship to the package. Please contact the lead author at , or:

By participating in this project, you agree to abide by the Contributor Code of Conduct v2.0. Contributions to the package must adhere to the tidyverse style guide. When contributing code, please add tests for that contribution to the tests/testthat folder, and ensure that these tests pass in the GitHub Actions panel.

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).