annalenalamprecht / worcs

Rstudio project template and convenience functions for the Workflow for Open Reproducible Code in Science (WORCS)

WORCS

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.

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

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

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")
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], or:

• File a GitHub issue here
• Make a pull request here

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 on Travis-CI.

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