workflowr

Workflowr: Terorganisir + Reproduksi + Ilmu Data yang Dapat Dibagikan di R

Paket Workflowr membantu para peneliti mengatur analisis mereka dengan cara yang mempromosikan manajemen proyek yang efektif, reproduktifitas, kolaborasi, dan berbagi hasil. Workflowr menggabungkan pemrograman literasi (Knitr dan Rmarkdown) dan Control Version (GIT, via Git2R) untuk menghasilkan situs web yang berisi hasil yang dicap waktu, versi, dan terdokumentasi. Setiap pengguna r dapat dengan cepat dan mudah mengadopsi workflowr.

Untuk detail lebih lanjut, lihat dokumentasi online. Sebagai contoh, lihat Proyek Eksplorasi Data Divvy. Untuk mengeksplorasi proyek penelitian yang dapat direproduksi yang difasilitasi oleh Workflowr, menelusuri proyek -proyek yang terdaftar di workflowr.io. Untuk tetap mengikuti perkembangan workflowr terbaru, silakan bergabung dengan milis workflowr-announce (volume rendah, baca saja). Untuk laporan bug, permintaan fitur, dan pertanyaan, silakan buka masalah.

• Fitur
• Instalasi
• Awal yang cepat
• Atribusi
• Berkontribusi

Fitur

• Terorganisir
  • Memberikan templat proyek dengan subdirektori terorganisir
  • Mencampur kode dan hasil dengan markdown r
  • Menggunakan git untuk versi kode sumber dan hasil
• Dapat direproduksi
  • Menampilkan versi kode yang digunakan untuk membuat setiap hasil
  • Menjalankan setiap analisis dalam sesi R yang terisolasi
  • Mencatat informasi sesi dari setiap analisis
  • Menetapkan benih yang sama untuk pembuatan angka acak untuk setiap analisis
• Dapat dibagikan
  • Membuat situs web untuk menyajikan hasil penelitian Anda
  • Dokumen cara meng -host situs web Anda secara gratis melalui halaman github atau halaman gitlab
  • Membuat tautan ke versi hasil masa lalu

Untuk melihat situs web Workflowr yang sedang beraksi, lihat demonstrasi video ini.

Untuk alat terkait, lihat R-Project-Workflows.

Instalasi

1. Instal r

   • (Disarankan) Instal rStudio

   • (Opsional) Instal Pandoc (instruksi)

   • (Opsional) Instal git

2. Instal Workflowr dari Cran:

   install.packages( " workflowr " )

3. Buat akun di GitHub atau Gitlab

Awal yang cepat

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

Langkah selanjutnya:

1. Bacalah sketsa memulai lengkap untuk mempelajari cara membagikan hasil Anda secara online. Atau, Anda dapat membaca sketsa lokakarya penelitian yang dapat direproduksi. Ini mencakup langkah yang sama, tetapi termasuk contoh kode dan data untuk menunjukkan beberapa fitur reproduktifitas workflowr

2. Baca sketsa kustomisasi untuk ide tentang cara menyesuaikan situs web penelitian Anda

3. Baca sketsa yang bermigrasi untuk bagaimana mengintegrasikan workflowr ke dalam proyek Anda yang ada

Atribusi

Workflowr dikembangkan, dan dipertahankan, oleh John Blischak, seorang peneliti postdoctoral di laboratorium Matthew Stephens di University of Chicago. Dia didanai oleh hibah dari Gordon dan Betty Moore Foundation untuk MS. Peter Carbonetto dan Matthew Stephens adalah rekan penulis.

Kami sangat berterima kasih kepada kontributor workflowr karena telah membantu meningkatkan paket. Kami juga berterima kasih kepada pengguna workflowr untuk menguji paket dan memberikan umpan balik --- terima kasih terutama kepada Lei Sun, Xiang Zhu, Wei Wang, dan anggota lainnya (dulu dan sekarang) dari Lab Stephens.

Paket Workflowr menggunakan banyak paket open source yang bagus. Yang sangat penting untuk proyek ini adalah paket R GIT2R, Knitr, dan Rmarkdown. Silakan lihat sketsa bagaimana paket workflowr bekerja untuk mempelajari tentang perangkat lunak yang memungkinkan workflowr.

Workflowr tersedia di bawah lisensi MIT. Untuk atribusi yang tepat, silakan kutip naskah kami yang menjelaskan perangkat lunak:

Blischak JD, Carbonetto P, dan Stephens M. Membuat dan berbagi kode penelitian yang dapat direproduksi dengan cara workflowr [Versi 1; Peer Review: 3 Disetujui]. F1000Research 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Untuk mendapatkan entri Bibtex, silakan jalankan citation("workflowr") . Perhatikan bahwa F1000Research menerbitkan tidak hanya versi asli tetapi juga revisi apa pun. Untuk memeriksa versi terbaru, silakan buka URL koran.

Berkontribusi

Kami menyambut kontribusi komunitas, terutama peningkatan dokumentasi. Untuk memulai, silakan baca pedoman yang berkontribusi. Juga, harap dicatat bahwa proyek ini dirilis dengan kode perilaku kontributor. Dengan berpartisipasi dalam proyek ini, Anda setuju untuk mematuhi persyaratannya.