Cargando…

Creating and sharing reproducible research code the workflowr way

Making scientific analyses reproducible, well documented, and easily shareable is crucial to maximizing their impact and ensuring that others can build on them. However, accomplishing these goals is not easy, requiring careful attention to organization, workflow, and familiarity with tools that are...

Descripción completa

Detalles Bibliográficos
Autores principales: Blischak, John D., Carbonetto, Peter, Stephens, Matthew
Formato: Online Artículo Texto
Lenguaje:English
Publicado: F1000 Research Limited 2019
Materias:
Acceso en línea:https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6833990/
https://www.ncbi.nlm.nih.gov/pubmed/31723427
http://dx.doi.org/10.12688/f1000research.20843.1
_version_ 1783466410315350016
author Blischak, John D.
Carbonetto, Peter
Stephens, Matthew
author_facet Blischak, John D.
Carbonetto, Peter
Stephens, Matthew
author_sort Blischak, John D.
collection PubMed
description Making scientific analyses reproducible, well documented, and easily shareable is crucial to maximizing their impact and ensuring that others can build on them. However, accomplishing these goals is not easy, requiring careful attention to organization, workflow, and familiarity with tools that are not a regular part of every scientist's toolbox. We have developed an R package, workflowr, to help all scientists, regardless of background, overcome these challenges. Workflowr aims to instill a particular "workflow" — a sequence of steps to be repeated and integrated into research practice — that helps make projects more reproducible and accessible.This workflow integrates four key elements: (1) version control (via Git); (2) literate programming (via R Markdown); (3) automatic checks and safeguards that improve code reproducibility; and (4) sharing code and results via a browsable website. These features exploit powerful existing tools, whose mastery would take considerable study. However, the workflowr interface is simple enough that novice users can quickly enjoy its many benefits. By simply following the workflowr "workflow", R users can create projects whose results, figures, and development history are easily accessible on a static website — thereby conveniently shareable with collaborators by sending them a URL — and accompanied by source code and reproducibility safeguards. The workflowr R package is open source and available on CRAN, with full documentation and source code available at https://github.com/jdblischak/workflowr.
format Online
Article
Text
id pubmed-6833990
institution National Center for Biotechnology Information
language English
publishDate 2019
publisher F1000 Research Limited
record_format MEDLINE/PubMed
spelling pubmed-68339902019-11-12 Creating and sharing reproducible research code the workflowr way Blischak, John D. Carbonetto, Peter Stephens, Matthew F1000Res Software Tool Article Making scientific analyses reproducible, well documented, and easily shareable is crucial to maximizing their impact and ensuring that others can build on them. However, accomplishing these goals is not easy, requiring careful attention to organization, workflow, and familiarity with tools that are not a regular part of every scientist's toolbox. We have developed an R package, workflowr, to help all scientists, regardless of background, overcome these challenges. Workflowr aims to instill a particular "workflow" — a sequence of steps to be repeated and integrated into research practice — that helps make projects more reproducible and accessible.This workflow integrates four key elements: (1) version control (via Git); (2) literate programming (via R Markdown); (3) automatic checks and safeguards that improve code reproducibility; and (4) sharing code and results via a browsable website. These features exploit powerful existing tools, whose mastery would take considerable study. However, the workflowr interface is simple enough that novice users can quickly enjoy its many benefits. By simply following the workflowr "workflow", R users can create projects whose results, figures, and development history are easily accessible on a static website — thereby conveniently shareable with collaborators by sending them a URL — and accompanied by source code and reproducibility safeguards. The workflowr R package is open source and available on CRAN, with full documentation and source code available at https://github.com/jdblischak/workflowr. F1000 Research Limited 2019-10-14 /pmc/articles/PMC6833990/ /pubmed/31723427 http://dx.doi.org/10.12688/f1000research.20843.1 Text en Copyright: © 2019 Blischak JD et al. http://creativecommons.org/licenses/by/4.0/ This is an open access article distributed under the terms of the Creative Commons Attribution Licence, which permits unrestricted use, distribution, and reproduction in any medium, provided the original work is properly cited.
spellingShingle Software Tool Article
Blischak, John D.
Carbonetto, Peter
Stephens, Matthew
Creating and sharing reproducible research code the workflowr way
title Creating and sharing reproducible research code the workflowr way
title_full Creating and sharing reproducible research code the workflowr way
title_fullStr Creating and sharing reproducible research code the workflowr way
title_full_unstemmed Creating and sharing reproducible research code the workflowr way
title_short Creating and sharing reproducible research code the workflowr way
title_sort creating and sharing reproducible research code the workflowr way
topic Software Tool Article
url https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6833990/
https://www.ncbi.nlm.nih.gov/pubmed/31723427
http://dx.doi.org/10.12688/f1000research.20843.1
work_keys_str_mv AT blischakjohnd creatingandsharingreproducibleresearchcodetheworkflowrway
AT carbonettopeter creatingandsharingreproducibleresearchcodetheworkflowrway
AT stephensmatthew creatingandsharingreproducibleresearchcodetheworkflowrway