Repository files navigation

The Workflow for Open Reproducible Code in Science (WORCS) is an easy toadopt approach to ensuring a research project meets the requirements ofOpen Science from the start. It is based on a “good enough” philosophy,prioritizing user-friendliness over exhaustiveness. It can be usedeither in absence of, or in parallel to, existing requirements for Openworkflows. It can also be enhanced with more elaborate solutions forspecific issues.

For most users, the recommended starting point is toread the paper,published in DataScience,which introduces the WORCS workflow, explains the underlying tools, andillustrates how theworcs package can be used to create a new projectthat follows the workflow.

The workflow is illustrated below; theworkflowvignettedescribes each step in detail.

Before installing the package, please readthisvignette, whichexplains how to set up your computer forworcs (using the CRANversion).

If you know what you’re doing and you wish to install the developmentversion of theworcs package from GitHub instead, you can use:

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

You can cite WORCS using the following citation (please use the samecitation 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. (2021). WORCS: AWorkflow for Open Reproducible Code in Science. Data Science. DataScience, vol. 4, no. 1, pp. 29-49. DOI: 10.3233/DS-210031.

This repository contains the following:

1. An R-package calledworcs, with convenience functions tofacilitate the WORCS workflow.
2. In the subfolder./paper, the source files for the paperdescribing the WORCS workflow.

The repository serves two functions: To allow users to install theworcs package, and to allow collaborators access to the source codefor the package and paper.

We are always eager to receive user feedback and contributions to helpus improve both the workflow and the software. Major contributionswarrant coauthorship to the package. Please contact the lead author atc.j.vanlissa@uu.nl, or:

• File a GitHub issue forfeedback, bug reports or feature requests
• Make a pull request tocontribute your code or prose

By participating in this project, you agree to abide by theContributorCode of Conduct v2.0.Contributions to the package must adhere to thetidyverse styleguide. When contributing code, please addtests for that contribution to thetests/testthat folder, and ensurethat these tests pass in theGitHub Actionspanel.

The worcs logo is inspired by the Open Science Badges by the Center forOpen Science (CC-BY-4.0), and makes use of the gear, services, gears,preferences, settings icon, made by MD Badsha Meah fromwww.freeicons.io(CC-BY-3.0).