workflowr

WorkflowR: Organisiert + reproduzierbare + gemeinsame Datenwissenschaft in R.

Das Workflowr R -Paket hilft den Forschern dabei, ihre Analysen so zu organisieren, dass das effektive Projektmanagement, die Reproduzierbarkeit, die Zusammenarbeit und das Austausch von Ergebnissen fördert. WorkflowR kombiniert die Lehrerprogrammierung (Knitr und Rmarkdown) und die Versionskontrolle (GIT, über GIT2R), um eine Website zu generieren, die zeitgestempelte, versionierte und dokumentierte Ergebnisse enthält. Jeder R -Benutzer kann WorkflowR schnell und einfach einnehmen.

Weitere Informationen finden Sie in der Online -Dokumentation. Ein Beispiel finden Sie im Projekt Divvy Data Exploration. Um reproduzierbare Forschungsprojekte zu untersuchen, die durch Workflowr erleichtert werden, durchsuchen Sie die bei Workflowr.io registrierten Projekte. Um über die neuesten WorkflowR-Entwicklungen auf dem Laufenden zu bleiben, nehmen Sie bitte an der Mailingliste für Workflowr-Announce (niedrigem Volumen, schreibgeschützt) teil. Für Fehlerberichte, Feature -Anfragen und Fragen öffnen Sie bitte ein Problem.

• Merkmale
• Installation
• Schneller Start
• Zuschreibung
• Beitragen

Merkmale

• Organisiert
  • Bietet eine Projektvorlage mit organisierten Unterverzeichnissen
  • Mischt Code und Ergebnisse mit R -Markdown
  • Verwendet Git, um sowohl Quellcode als auch Ergebnisse zu verstellen
• Reproduzierbar
  • Zeigt die Codeversion an, mit der jedes Ergebnis erstellt wird
  • Führt jede Analyse in einer isolierten R -Sitzung aus
  • Erfasst die Sitzungsinformationen jeder Analyse
  • Legt für jede Analyse den gleichen Samen für die Zufallszahlenerzeugung fest
• Freiwillig
  • Erstellt eine Website, um Ihre Forschungsergebnisse zu präsentieren
  • Dokumente, wie Sie Ihre Website kostenlos über Github -Seiten oder GitLab -Seiten hosten
  • Erstellt Links zu früheren Versionen von Ergebnissen

Eine WorkflowR -Website in Aktion finden Sie in dieser Videodemonstration.

Für verwandte Tools siehe R-Project-Workflows.

Installation

1. Installieren r

   • (Empfohlen) RStudio installieren

   • (Optional) Installieren Sie Pandoc (Anweisungen)

   • (Optional) Git installieren

2. Installieren Sie WorkflowR von Cran:

   install.packages( " workflowr " )

3. Erstellen Sie ein Konto auf Github oder GitLab

Schneller Start

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

Nächste Schritte:

1. Lesen Sie die volle Erste -Start -Vignette, um zu erfahren, wie Sie Ihre Ergebnisse online teilen können. Alternativ können Sie die reproduzierbare Forschungsworkshop -Vignette lesen. Es deckt die gleichen Schritte ab, enthält jedoch Beispielcode und Daten, um einige der Reproduzierbarkeitsfunktionen von Workflowr zu demonstrieren

2. Lesen Sie die Anpassungsvignette, um Ideen zum Anpassen Ihrer Forschungswebsite anzupassen

3. Lesen Sie die migrierende Vignette, um WorkflowR in Ihr vorhandenes Projekt zu integrieren

Zuschreibung

Workflowr wurde entwickelt und wird von John Blischak, einem Postdoktorandenforscher im Labor von Matthew Stephens an der Universität von Chicago, entwickelt. Er wird durch ein Stipendium der Gordon und Betty Moore Foundation an MS finanziert. Peter Carbonetto und Matthew Stephens sind Co-Autoren.

Wir sind den WorkflowR -Mitwirkenden sehr dankbar, dass sie das Paket verbessern können. Wir sind auch für WorkflowR-Benutzer dankbar für das Testen des Pakets und für das Feedback-vor allem an Lei Sun, Xiang Zhu, Wei Wang und andere Mitglieder (Vergangenheit und Gegenwart) des Stephens-Labors.

Das WorkflowR -Paket verwendet viele großartige Open Source -Pakete. Besonders wichtig für dieses Projekt sind die R -Pakete Git2R, Knitr und Rmarkdown. Bitte sehen Sie die Vignette, wie das WorkflowR -Paket funktioniert, um die Software zu erfahren, die WorkflowR ermöglicht.

WorkflowR ist im Rahmen der MIT -Lizenz verfügbar. Für ordnungsgemäße Zuschreibung zitieren bitte unser Manuskript, das die Software beschreibt:

Blischak JD, Carbonetto P und Stephens M. Erstellen und Teilen von reproduzierbarem Forschungscode Der Workflowr -Weg [Version 1; Peer Review: 3 Genehmigt]. F1000Research 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Um einen Bibtex -Eintrag zu erhalten, führen Sie bitte citation("workflowr") . Beachten Sie, dass F1000Research nicht nur die Originalversion, sondern auch irgendwelche Überarbeitungen veröffentlicht. Um nach der neuesten Version zu suchen, gehen Sie bitte zur URL des Papiers.

Beitragen

Wir begrüßen Community -Beiträge, insbesondere Verbesserungen der Dokumentation. Wenn Sie loslegen, lesen Sie bitte die beitragenden Richtlinien. Bitte beachten Sie außerdem, dass dieses Projekt mit einem Mitwirkenden -Verhaltenskodex veröffentlicht wird. Wenn Sie an diesem Projekt teilnehmen, erklären Sie sich damit einverstanden, sich an seine Bedingungen einzuhalten.