Package: worcs 0.1.15

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.15.tar.gz
worcs_0.1.15.zip(r-4.5)worcs_0.1.15.zip(r-4.4)worcs_0.1.15.zip(r-4.3)
worcs_0.1.15.tgz(r-4.4-any)worcs_0.1.15.tgz(r-4.3-any)
worcs_0.1.15.tar.gz(r-4.5-noble)worcs_0.1.15.tar.gz(r-4.4-noble)
worcs_0.1.15.tgz(r-4.4-emscripten)worcs_0.1.15.tgz(r-4.3-emscripten)
worcs.pdf |worcs.html✨
worcs/json (API)

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

Peer review:

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

Datasets:

On CRAN:

41 exports 76 stars 3.97 score 56 dependencies 54 scripts 1.2k downloads

Last updated 3 days agofrom:aa476dc1d5. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 15 2024
R-4.5-winOKSep 15 2024
R-4.5-linuxOKSep 15 2024
R-4.4-winOKSep 15 2024
R-4.4-macOKSep 15 2024
R-4.3-winOKSep 15 2024
R-4.3-macOKSep 15 2024

Exports:add_endpointadd_manuscriptadd_preregistrationadd_recipeadd_syntheticadd_targetscheck_dependenciescheck_endpointscheck_gitcheck_githubcheck_renvcheck_rmarkdowncheck_sshcheck_tinytextcheck_worcscheck_worcs_installationcite_allcite_essentialclosed_datadata_labeldata_unlabeldescriptivesexport_projectgit_ignoregit_updategit_usergithub_action_check_endpointsgithub_action_reproducehas_git_userload_dataload_entrypointmake_codebooknotify_syntheticopen_datareportreproduceskew_kurtosissnapshot_endpointssyntheticworcs_badgeworcs_project

Dependencies:askpassbase64encbslibcachemclicliprcrayoncredentialscurldescdigestevaluatefastmapfontawesomefsgertghgitcredsgluehighrhtmltoolshttr2inijquerylibjsonliteknitrlatticelifecyclemagrittrMatrixmemoisemimeopensslpreregpurrrR6rangerrappdirsRcppRcppEigenrenvrlangrmarkdownrprojrootrstudioapirticlessasssystinytexusethisvctrswhiskerwithrxfunyamlzip

Citing references in worcs

Rendered fromcitation.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2024-09-13
Started: 2020-05-25

Connecting to 'Git' remote repositories

Rendered fromgit_cloud.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2023-08-22
Started: 2020-05-18

Reproducing a WORCS project

Rendered fromreproduce.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2023-09-13
Started: 2020-11-20

Setting up your computer for WORCS

Rendered fromsetup.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2022-12-18
Started: 2020-02-04

Setting up your computer for WORCS - Docker-edition

Rendered fromsetup-docker.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2021-02-02
Started: 2020-11-17

The WORCS workflow, version 0.1.6

Rendered fromworkflow.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2024-09-14
Started: 2020-05-20

Using Custom Synthetic Data

Rendered fromsynthetic_data.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2024-09-12
Started: 2024-01-24

Using Endpoints to Check Reproducibility

Rendered fromendpoints.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2023-09-12
Started: 2023-07-21

Using targets to Reduce Redundant Computations

Rendered fromtargets.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2024-09-15
Started: 2024-01-24

Readme and manuals

Help Manual

Help pageTopics
Add endpoint to WORCS projectadd_endpoint
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
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_rmarkdown check_ssh check_tinytext 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
Add, commit, and push changes.git_update
Set global 'Git' credentialsgit_user
Set up GitHub Actions to Check Endpointsgithub_action_check_endpoints
Set up GitHub Action to Reproduce WORCS Projectgithub_action_reproduce
Check whether global 'Git' credentials existhas_git_user
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
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
Create new WORCS projectworcs_project