workflowr

Workflowr: Organisé + Reproductible + Science des données partageables en R

Le package de workflowr r aide les chercheurs à organiser leurs analyses d'une manière qui favorise la gestion efficace de projet, la reproductibilité, la collaboration et le partage des résultats. Workflowr combine la programmation alphabétisée (Knitr et RMarkdown) et le contrôle de version (GIT, via GIT2R) pour générer un site Web contenant des résultats horodatés, versionnés et documentés. Tout utilisateur R peut adopter rapidement et facilement le flux de travail.

Pour plus de détails, consultez la documentation en ligne. Par exemple, voir le projet d'exploration des données Divvy. Pour explorer les projets de recherche reproductibles facilités par Workflowr, parcourez les projets enregistrés sur Workflowr.io. Pour rester à jour avec les derniers développements Workflowr, veuillez rejoindre la liste de diffusion Workflowr-ANNUNCH (faible volume, en lecture seule). Pour les rapports de bogues, les demandes de fonctionnalités et les questions, veuillez ouvrir un problème.

• Caractéristiques
• Installation
• Démarrage rapide
• Attribution
• Contributif

Caractéristiques

• Organisé
  • Fournit un modèle de projet avec des sous-répertoires organisés
  • Mélange le code et les résultats avec R Markdown
  • Utilise Git pour version à la fois le code source et les résultats
• Reproductible
  • Affiche la version de code utilisée pour créer chaque résultat
  • Exécute chaque analyse dans une session R isolée
  • Enregistre les informations de session de chaque analyse
  • Définit la même graine pour la génération de nombres aléatoires pour chaque analyse
• Partageable
  • Crée un site Web pour présenter vos résultats de recherche
  • Documents Comment héberger votre site Web gratuitement via les pages GitHub ou les pages GitLab
  • Crée des liens vers les versions passées des résultats

Pour voir un site Web Workflowr en action, consultez cette démonstration vidéo.

Pour les outils connexes, voir R-Project-Workflows.

Installation

1. Installer r

   • (Recommandé) Installer RStudio

   • (Facultatif) Installer Pandoc (instructions)

   • (Facultatif) Installer Git

2. Installez Workflowr depuis Cran:

   install.packages( " workflowr " )

3. Créer un compte sur GitHub ou GitLab

Démarrage rapide

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

Étapes suivantes:

1. Lisez la vignette complète de démarrage pour apprendre à partager vos résultats en ligne. Alternativement, vous pouvez lire la vignette de l'atelier de recherche reproductible. Il couvre les mêmes étapes, mais inclut un exemple de code et de données pour démontrer certaines des fonctionnalités de reproductibilité de Workflowr

2. Lisez la vignette de personnalisation pour des idées sur la façon de personnaliser votre site Web de recherche

3. Lisez la vignette migratrice pour intégrer le flux de travail dans votre projet existant

Attribution

Workflowr a été développé et est maintenu par John Blischak, un chercheur postdoctoral au laboratoire de Matthew Stephens à l'Université de Chicago. Il est financé par une subvention de la Fondation Gordon et Betty Moore à MS. Peter Carbonetto et Matthew Stephens sont des co-auteurs.

Nous sommes très reconnaissants aux contributeurs de workflowr pour avoir contribué à améliorer le package. Nous sommes également reconnaissants pour les utilisateurs de workflowr pour avoir testé le package et fourni des commentaires --- grâce en particulier à Lei Sun, Xiang Zhu, Wei Wang et à d'autres membres (passés et présents) du laboratoire Stephens.

Le package Workflowr utilise de nombreux forages open source. Les packages R Git2R, Knitr et RMarkdown sont particulièrement essentiels pour ce projet. Veuillez consulter la vignette comment le package de workflowr fonctionne pour en savoir plus sur le logiciel qui rend possible Workflowr.

Workflowr est disponible sous la licence MIT. Pour une bonne attribution, veuillez citer notre manuscrit qui décrit le logiciel:

Blischak JD, Carbonetto P et Stephens M. Création et partageant du code de recherche reproductible The Workflowr Way [Version 1; Examen par les pairs: 3 approuvés]. F1000Research 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Pour obtenir une entrée Bibtex, veuillez exécuter citation("workflowr") . Notez que F1000Research publie non seulement la version originale mais aussi toutes les révisions. Pour vérifier la dernière version, veuillez consulter l'URL du papier.

Contributif

Nous accueillons les contributions communautaires, en particulier les améliorations à la documentation. Pour commencer, veuillez lire les directives contributives. Veuillez également noter que ce projet est publié avec un code de conduite de contributeur. En participant à ce projet, vous acceptez de respecter ses conditions.