Package: worcs 0.1.21.1

worcs: Workflow for Open Reproducible Code in Science

Create reproducible and transparent research projects in 'R'. This package is based on the Workflow for Open Reproducible Code in Science (WORCS), a step-by-step procedure based on best practices for Open Science. It includes an 'RStudio' project template, several convenience functions, and all dependencies required to make your project reproducible and transparent. WORCS is explained in the tutorial paper by Van Lissa, Brandmaier, Brinkman, Lamprecht, Struiksma, & Vreede (2021). <doi:10.3233/DS-210031>.

Authors:Caspar J. Van Lissa [aut, cre], Aaron Peikert [aut], Andreas M. Brandmaier [aut]

worcs_0.1.21.1.tar.gz
worcs_0.1.21.1.zip(r-4.7)worcs_0.1.21.1.zip(r-4.6)worcs_0.1.21.1.zip(r-4.5)
worcs_0.1.21.1.tgz(r-4.6-any)worcs_0.1.21.1.tgz(r-4.5-any)
worcs_0.1.21.1.tar.gz(r-4.7-any)worcs_0.1.21.1.tar.gz(r-4.6-any)
worcs_0.1.21.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
worcs/json (API)

# Install 'worcs' in R:
install.packages('worcs', repos = c('https://cjvanlissa.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/cjvanlissa/worcs/issues

Pkgdown/docs site:https://cjvanlissa.github.io

Datasets:

On CRAN:

Conda:

9.98 score 88 stars 1 packages 110 scripts 877 downloads 53 exports 55 dependencies

Last updated from:ff7d2a9853. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK247
source / vignettesOK241
linux-release-x86_64OK254
macos-release-arm64OK145
macos-oldrel-arm64OK127
windows-develOK193
windows-releaseOK205
windows-oldrelOK196
wasm-releaseOK192

Exports:add_endpointadd_license_fileadd_manuscriptadd_preregistrationadd_recipeadd_syntheticadd_targetsadd_testthatcheck_dependenciescheck_endpointscheck_gitcheck_githubcheck_renvcheck_renv_synchronizedcheck_rmarkdowncheck_sshcheck_tinytexcheck_worcscheck_worcs_installationcite_allcite_essentialclosed_datadata_labeldata_unlabeldescriptivesexport_projectgit_ignoregit_release_publishgit_remote_connectgit_remote_creategit_updategit_usergithub_action_check_endpointsgithub_action_reproducegithub_action_testthathas_git_userlist_endpointsload_dataload_entrypointmake_codebooknotify_syntheticopen_dataremove_endpointreportreproduceskew_kurtosissnapshot_endpointssynthetictest_worcsworcs_badgeworcs_pathworcs_projectworcs_root

Dependencies:askpassbase64encbslibcachemclicliprcrayoncredentialscurldescdigestevaluatefastmapfontawesomefsgertgitcredsgluehighrhtmltoolshttr2inijquerylibjsonliteknitrlatticelifecyclemagrittrMatrixmemoisemimeopensslpreregpurrrR6rangerrappdirsRcppRcppEigenrenvrlangrmarkdownrprojrootrstudioapirticlessasssystinytexusethisvctrswhiskerwithrxfunyamlzip

Creating a New worcs Project
Checking the Installation | Prepare a dataset using prepare_data.R | Add the Dataset to the Repository | Add some demo analyses | Reproduce the Project
Rendered fromcreate_project.Rmdusingknitr::rmarkdown

Last update: 2026-03-27
Started: 2026-03-27

Setting up your computer for WORCS
Optional step
Rendered fromsetup.Rmdusingknitr::rmarkdown

Last update: 2026-03-20
Started: 2020-02-04

Citing references in worcs
Rendered fromcitation.Rmdusingknitr::rmarkdown

Last update: 2026-02-22
Started: 2020-05-25

Archiving a WORCS Project on 'Zenodo'
Steps Involved | Check 'Git' and 'GitHub' | Optionally: Connect Local to Remote ('GitHub') Repository | Snapshot renv Dependencies | Pushing These Changes to the Remote Repository | Check Your 'GitHub' Repository | Login to 'Zenodo' | Authorize 'GitHub' to connect with 'Zenodo' | Select the Repository to Archive | Optional: Check repository settings | Create a New Release | Verify on 'Zenodo' | Optionally: Updating Meta-Data | Verifying That 'Zenodo' Mints a DOI for Your Project | CONGRATULATIONS! | Checklist for citing your project
Rendered fromzenodo.Rmdusingknitr::rmarkdown

Last update: 2026-02-22
Started: 2026-02-21

Reproducing a WORCS project
Install 'RStudio' and 'R' | Install R-package dependencies | Verifying WORCS Installation | Obtaining the project repository | Open the project in 'RStudio' | Restore the package dependencies | Open the project entry point | Reproduce the analyses | No access to original data
Rendered fromreproduce.Rmdusingknitr::rmarkdown

Last update: 2026-01-22
Started: 2020-11-20

The WORCS workflow, version 0.1.16
WORCS: Steps to follow for a project | Phase 1: Study design | Phase 2: Writing and analysis | Phase 3: Submission and publication | Notes for cautious researchers | Sample WORCS projects
Rendered fromworkflow.Rmdusingknitr::rmarkdown

Last update: 2026-01-22
Started: 2020-05-20

Using Endpoints to Check Reproducibility
Adding endpoints | Integration Tests as Endpoints | Adding Integration Tests | Reproducing a Project | Checking reproducibility | Updating endpoints | Automating Reproducibility | Automating Endpoint Checks
Rendered fromendpoints.Rmdusingknitr::rmarkdown

Last update: 2026-01-22
Started: 2023-07-21

Connecting to 'Git' remote repositories
GitLab | Setup steps (do this only once) | Connect new worcs project to 'GitLab' | Bitbucket | Connect new worcs project to 'Bitbucket'
Rendered fromgit_cloud.Rmdusingknitr::rmarkdown

Last update: 2026-01-21
Started: 2020-05-18

Setting up your computer for WORCS - Docker-edition
Rendered fromsetup-docker.Rmdusingknitr::rmarkdown

Last update: 2026-01-21
Started: 2020-11-17

Using Custom Synthetic Data
Generating Data from a Structural Equation Model | Illustrating the Problem | Adding a Custom Dataset
Rendered fromsynthetic_data.Rmdusingknitr::rmarkdown

Last update: 2026-01-21
Started: 2024-01-24

Using targets to Reduce Redundant Computations
Defining a Pipeline | Using targets Markdown
Rendered fromtargets.Rmdusingknitr::rmarkdown

Last update: 2026-01-21
Started: 2024-01-24

Readme and manuals

Help Manual

Help pageTopics
Add endpoint to WORCS projectadd_endpoint
Add License File to Projectadd_license_file
Add Rmarkdown manuscriptadd_manuscript
Add Rmarkdown preregistrationadd_preregistration
Add Recipe to Generate Endpointsadd_recipe
Add synthetic data to WORCS projectadd_synthetic
Add targets to WORCS Projectadd_targets
Add testthat to WORCS Projectadd_testthat test_worcs
Check endpoints in WORCS projectcheck_endpoints
Evaluate project with respect to WORCS checklistcheck_worcs
Check worcs dependenciescheck_dependencies check_git check_github check_renv check_renv_synchronized check_rmarkdown check_ssh check_tinytex check_worcs_installation
Comprehensive citation Knit function for 'RStudio'cite_all
Essential citations Knit function for 'RStudio'cite_essential
Use closed data in WORCS projectclosed_data
Label factor variables using metadatadata_label
Drop value labelsdata_unlabel
Describe a datasetdescriptives
Export project to .zip fileexport_project
Modify .gitignore filegit_ignore
Publish a Release on 'GitHub'git_release_publish
Connect to Existing 'GitHub' Repositorygit_remote_connect
Create a New 'GitHub' Repositorygit_remote_create
Add, commit, and push changes.git_update
Set global 'Git' credentialsgit_user
Set up GitHub Actions to Check Endpointsgithub_action_check_endpoints github_action_reproduce github_action_testthat
Check whether global 'Git' credentials existhas_git_user
List endpoints in WORCS projectlist_endpoints
Load WORCS project dataload_data
Load project entry pointsload_entrypoint
Create codebook for a datasetmake_codebook
Notify the user when synthetic data are being usednotify_synthetic
Use open data in WORCS projectopen_data
Remove endpoint from WORCS projectremove_endpoint
Reproduce WORCS Projectreproduce
Calculate skew and kurtosisskew_kurtosis
Snapshot endpoints in WORCS projectsnapshot_endpoints
Generate synthetic datasynthetic
Add WORCS badge to README.mdworcs_badge
WORCS checklistworcs_checklist
Specify File Path Relative to WORCS Project Directoryworcs_path
Create new WORCS projectworcs_project
Return Absolute File Path of WORCS Project Directoryworcs_root