workflowr

Flowr de trabalho: Organizado + Reprodutível + Ciência de Dados Compartilhável em R

O pacote de fluxo de trabalho R ajuda os pesquisadores a organizar suas análises de uma maneira que promova o gerenciamento eficaz de projetos, a reprodutibilidade, a colaboração e o compartilhamento de resultados. O Workflowr combina programação alfabetizada (Knitr e Rmarkdown) e controle de versão (Git, via Git2R) para gerar um site contendo resultados estampados, versões e documentadas. Qualquer usuário R pode adotar de maneira rápida e fácil o fluxo de trabalho.

Para mais detalhes, consulte a documentação online. Para um exemplo, consulte o Divvy Data Exploration Project. Para explorar os projetos de pesquisa reprodutível facilitados pelo Workflowr, navegue pelos projetos registrados no Workflowr.io. Para manter-se atualizado com os desenvolvimentos mais recentes do fluxo de trabalho, junte-se à lista de discussão do fluxo de trabalho (baixo volume, somente leitura). Para relatórios de bugs, solicitações de recursos e perguntas, abra um problema.

• Características
• Instalação
• Início rápido
• Atribuição
• Contribuindo

Características

• Organizado
  • Fornece um modelo de projeto com subdiretos organizados
  • Mistura código e resultados com r Markdown
  • Usa o git para versionar o código -fonte e os resultados
• Reproduzível
  • Exibe a versão de código usada para criar cada resultado
  • Executa cada análise em uma sessão R isolada
  • Registra as informações da sessão de cada análise
  • Define a mesma semente para geração de números aleatórios para cada análise
• Compartilhável
  • Cria um site para apresentar seus resultados de pesquisa
  • Documentos como hospedar seu site gratuitamente via páginas do github ou páginas do Gitlab
  • Cria links para versões passadas dos resultados

Para ver um site de fluxo de trabalho em ação, consulte esta demonstração de vídeo.

Para ferramentas relacionadas, consulte R-Project-Work Flows.

Instalação

1. Instale r

   • (Recomendado) Instale o RStudio

   • (Opcional) Instale o Pandoc (Instruções)

   • (Opcional) Instale o git

2. Instale o Workflowr a partir de Cran:

   install.packages( " workflowr " )

3. Crie uma conta no Github ou Gitlab

Início 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")

PRÓXIMOS PASSOS:

1. Leia a vinheta completa para aprender a compartilhar seus resultados online. Como alternativa, você pode ler a vinheta reproduzível da Oficina de Pesquisa. Ele abrange as mesmas etapas, mas inclui código e dados de exemplo para demonstrar alguns dos recursos de reprodutibilidade do fluxo de trabalho

2. Leia a vinheta de personalização para obter idéias sobre como personalizar seu site de pesquisa

3. Leia a vinheta migratória para como integrar o fluxo de trabalho em seu projeto existente

Atribuição

O Workflowr foi desenvolvido e é mantido por John Blischak, pesquisador de pós -doutorado no laboratório de Matthew Stephens na Universidade de Chicago. Ele é financiado por uma concessão da Fundação Gordon e Betty Moore para a MS. Peter Carbonetto e Matthew Stephens são co-autores.

Somos muito gratos aos colaboradores do fluxo de trabalho por ajudar a melhorar o pacote. Também somos gratos pelos usuários do Flowr Work por testarem o pacote e o fornecimento de feedback-obrigado especialmente a Lei Sun, Xiang Zhu, Wei Wang e outros membros (passado e presente) do Stephens Lab.

O pacote de fluxo de trabalho usa muitos ótimos pacotes de código aberto. Especialmente crítico para este projeto são os pacotes R Git2R, Knitr e Rmarkdown. Consulte a vinheta como o pacote de fluxo de trabalho funciona para aprender sobre o software que torna possível o fluxo de trabalho.

O Workflowr está disponível sob a licença do MIT. Para uma atribuição adequada, cite nosso manuscrito que descreve o software:

Blischak JD, Carbonetto P e Stephens M. Criando e compartilhando o código de pesquisa reproduzível do Workflowr Way [versão 1; Revisão por pares: 3 aprovado]. F1000Rearch 2019, 8: 1749 (https://doi.org/10.12688/f1000research.20843.1)

Para obter uma entrada do BibTex, execute citation("workflowr") . Observe que o F1000Research publica não apenas a versão original, mas também quaisquer revisões. Para verificar a versão mais recente, vá ao URL do papel.

Contribuindo

Congratulamo -nos com contribuições da comunidade, especialmente melhorias na documentação. Para começar, leia as diretrizes contribuintes. Além disso, observe que este projeto é lançado com um código de conduta colaborador. Ao participar deste projeto, você concorda em cumprir seus termos.