workflowr

Workflowr: организованный + воспроизводимый + совместная наука данных в R

Пакет Workflowr R помогает исследователям организовать свои анализы таким образом, чтобы способствовать эффективному управлению проектами, воспроизводимостью, сотрудничеству и обмену результатами. Workflowr объединяет грамотное программирование (Knitr и Rmarkdown) и контроль версий (GIT, через GIT2R), чтобы создать веб-сайт, содержащий временные, версированные и задокументированные результаты. Любой пользователь R может быстро и легко принять Workflowr.

Для получения более подробной информации см. Онлайн -документацию. Для примера см. Проект разведки Divvy Data. Чтобы изучить воспроизводимые исследовательские проекты, облегченные рабочим цветом, просмотрите проекты, зарегистрированные на Workflowr.io. Чтобы быть в курсе последних разработок Workflowr, присоединяйтесь к списку рассылки Workflowr-Announce (низкий объем, только для чтения). Для отчетов об ошибках, запросов на функции и вопросов, пожалуйста, откройте проблему.

• Функции
• Установка
• Быстрый старт
• Атрибуция
• Внося

Функции

• Организованный
  • Предоставляет шаблон проекта с организованными подкатариями
  • Смешивает код и результаты с маркой R
  • Использует GIT для версии как исходного кода, так и результатов
• Воспроизводимый
  • Отображает код версию, используемой для создания каждого результата
  • Запускает каждый анализ в изолированном сеансе R
  • Записывает информацию о сеансе каждого анализа
  • Устанавливает одно и то же семя для генерации случайных чисел для каждого анализа
• Совместный
  • Создает веб -сайт, чтобы представить результаты исследования
  • Документы, как бесплатно размещать ваш сайт через страницы GitHub или Gitlab Pages
  • Создает ссылки на прошлые версии результатов

Чтобы увидеть веб -сайт Workflowr в действии, см. Эта демонстрация видео.

Для связанных инструментов см. Rproject-Workflows.

Установка

1. Установить r

   • (Рекомендуется) Установить RSTUDIO

   • (Необязательно) Установить Pandoc (инструкции)

   • (Необязательно) Установить git

2. Установите Workflowr из Cran:

   install.packages( " workflowr " )

3. Создайте учетную запись на GitHub или Gitlab

Быстрый старт

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

Следующие шаги:

1. Прочтите полное начало работы в виньетке, чтобы узнать, как поделиться своими результатами в Интернете. В качестве альтернативы вы можете прочитать воспроизводимую исследовательскую мастерскую виньетку. Он охватывает те же шаги, но включает в себя пример кода и данные, чтобы продемонстрировать некоторые функции воспроизводимости Workflowr

2. Прочитайте виньетку настройки для идей о том, как настроить свой исследовательский веб -сайт

3. Прочитайте мигрирующую виньетку, чтобы интегрировать Workflowr в существующий проект

Атрибуция

Workflowr был разработан и поддерживается Джоном Блишаком, постдокторским исследователем в лаборатории Мэтью Стивенса в Чикагском университете. Он финансируется грантом от Фонда Гордона и Бетти Мур на MS. Питер Карбонто и Мэтью Стивенс являются соавторами.

Мы очень благодарны участникам Workflowr за помощь в улучшении пакета. Мы также благодарны пользователям Workflowr за тестирование пакета и предоставление обратной связи-особенно благодаря Лей Сан, Сян Чжу, Вей Ван и другим участникам (прошлое и настоящее) лаборатории Стивенса.

В пакете Workflowr используется много отличных пакетов с открытым исходным кодом. Особенно решающим для этого проекта являются R Packages GIT2R, Knitr и Rmarkdown. Пожалуйста, посмотрите Vignette, как работает пакет Workflowr, чтобы узнать о программном обеспечении, которое делает возможным WorkFlowR.

Workflowr доступен по лицензии MIT. Для правильной атрибуции, пожалуйста, укажите нашу рукопись, которая описывает программное обеспечение:

Blischak JD, Carbonetto P и Stephens M. Создание и обмен воспроизводимым кодом исследования The Workflowr Way [версия 1; Осмотр сверстников: 3 утверждено]. F1000Research 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Чтобы получить запись Bibtex, запустите citation("workflowr") . Обратите внимание, что F1000Research публикует не только оригинальную версию, но и любые изменения. Чтобы проверить последнюю версию, перейдите на URL -адрес бумаги.

Внося

Мы приветствуем вклад сообщества, особенно улучшения документации. Чтобы начать, пожалуйста, прочитайте рекомендации. Кроме того, обратите внимание, что этот проект выпущен с кодексом поведения участника. Участвуя в этом проекте, вы соглашаетесь соблюдать его условия.