workflowr

Workflowr: organizado + reproducible + ciencia de datos compartible en R

El paquete Workflowr R ayuda a los investigadores a organizar sus análisis de una manera que promueva la gestión efectiva de proyectos, la reproducibilidad, la colaboración y el intercambio de resultados. Workflowr combina la programación alfabetizada (Knitr y Rmarkdown) y el control de versiones (GIT, a través de GIT2R) para generar un sitio web que contiene resultados de tiempo estampados, versionados y documentados. Cualquier usuario R puede adoptar rápida y fácilmente el flujo de trabajo.

Para obtener más detalles, consulte la documentación en línea. Para un ejemplo, consulte el proyecto Divvy Data Exploration. Para explorar proyectos de investigación reproducibles facilitados por Workflowr, explore los proyectos registrados en Workflowr.io. Para mantenerse actualizado con los últimos desarrollos de flujo de trabajo, únase a la lista de correo de aviso de flujo de trabajo (bajo volumen, solo lectura). Para informes de errores, solicitudes de funciones y preguntas, abra un problema.

• Características
• Instalación
• Comienzo rápido
• Atribución
• Que contribuye

Características

• Organizado
  • Proporciona una plantilla de proyecto con subdirectorios organizados
  • Mezcla código y resultados con R Markdown
  • Usa git a versión tanto código fuente como resultados
• Reproducible
  • Muestra la versión de código utilizada para crear cada resultado
  • Ejecuta cada análisis en una sesión R aislada
  • Registra la información de la sesión de cada análisis
  • Establece la misma semilla para la generación de números aleatorios para cada análisis
• Compartible
  • Crea un sitio web para presentar sus resultados de investigación
  • Documentos cómo alojar su sitio web de forma gratuita a través de páginas Github o Gitlab
  • Crea enlaces a versiones pasadas de resultados

Para ver un sitio web de flujo de trabajo en acción, vea esta demostración de video.

Para herramientas relacionadas, consulte R-Project-Workflows.

Instalación

1. Instalar R

   • (Recomendado) Instale rstudio

   • (Opcional) Instale pandoc (instrucciones)

   • (Opcional) Instale git

2. Instale el flujo de trabajo de CRAN:

   install.packages( " workflowr " )

3. Crea una cuenta en Github o Gitlab

Comienzo rápido

 library("workflowr")

# Configure Git (only need to do once per computer)
wflow_git_config(user.name = "Full Name", user.email = "email@domain")

# Start a new workflowr project
wflow_start("myproject")

# Build the site
wflow_build()

# Customize your site!
#   1. Edit the R Markdown files in analysis/
#   2. Edit the theme and layout in analysis/_site.yml
#   3. Add new or copy existing R Markdown files to analysis/

# Preview your changes
wflow_build()

# Publish the site, i.e. version the source code and HTML results
wflow_publish("analysis/*", "Start my new project")

Siguientes pasos:

1. Lea la viñeta de inicio completa para aprender a compartir sus resultados en línea. Alternativamente, podría leer la viñeta de taller de investigación reproducible. Cubre los mismos pasos, pero incluye código de ejemplo y datos para demostrar algunas de las funciones de reproducibilidad de flujo de trabajo

2. Lea la viñeta de personalización para obtener ideas sobre cómo personalizar su sitio web de investigación

3. Lea la viñeta migratoria sobre cómo integrar el flujo de trabajo en su proyecto existente

Atribución

Workflowr fue desarrollado y es mantenido por John Blischak, un investigador postdoctoral en el laboratorio de Matthew Stephens de la Universidad de Chicago. Está financiado por una subvención de la Fundación Gordon y Betty Moore a MS. Peter Carbonetto y Matthew Stephens son coautores.

Estamos muy agradecidos con los contribuyentes de flujo de trabajo por ayudar a mejorar el paquete. También estamos agradecidos por los usuarios de flujo de trabajo por probar el paquete y proporcionar comentarios, gracias especialmente a Lei Sun, Xiang Zhu, Wei Wang y otros miembros (pasado y presente) del Laboratorio de Stephens.

El paquete de flujo de trabajo utiliza muchos paquetes de código abierto excelentes. Especialmente críticos para este proyecto son los paquetes R Git2r, Knitr y Rmarkdown. Consulte la viñeta cómo funciona el paquete de flujo de trabajo para conocer el software que hace posible el flujo de trabajo.

Workflowr está disponible bajo la licencia MIT. Para una atribución adecuada, cite nuestro manuscrito que describe el software:

Blischak JD, Carbonetto P y Stephens M. Creación y compartir el código de investigación reproducible la forma de flujo de trabajo [Versión 1; Revisión por pares: 3 aprobado]. F1000Research 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Para obtener una entrada de Bibtex, ejecute citation("workflowr") . Tenga en cuenta que F1000Research publica no solo la versión original sino también cualquier revisión. Para verificar la última versión, vaya a la URL del periódico.

Que contribuye

Damos la bienvenida a las contribuciones de la comunidad, especialmente mejoras a la documentación. Para comenzar, lea las pautas contribuyentes. Además, tenga en cuenta que este proyecto se publica con un código de conducta de contribuyentes. Al participar en este proyecto, acepta cumplir con sus términos.