chircollab / chircollab20

Home for the 2020 Chicago R Collab event
https://chircollab.github.io/
10 stars 3 forks source link

Contribute to the workflowr package for reproducible research #20

Closed jdblischak closed 4 years ago

jdblischak commented 4 years ago

Hi all! I'm the author of the R package workflowr. The package combines R Markdown, Git for version control, and reproducibility best practices to create a version-controlled, reproducible website to share your data analysis results.

I am interested in mentoring new contributors to the package. I have tagged a few issues for potential contributors to work on. They range in difficulty from adding an if statement to creating a new function from scratch, so you can contribute no matter your previous R experience.

I know that contributing to an existing project can seem daunting, but I'll guide you through the entire process. Furthermore, I'll teach you how to effectively use Git and GitHub, and also how to document and test an R package.

Please let me know if you are interested in working on any of these issues below.

  1. Improve error handling of argument overwrite to wflow_start()
    • You'll write an if statement to catch a potential problem and write an error message to alert the user
  2. Wrapper function to enhance RStudio Project Template
    • You'll write a short function that will receive input from RStudio, validate the input, and then pass it to a workflowr function
  3. Data licenses for wflow_license()
    • You'll write a new function that will add open source licenses to a user's project. This issue would be especially useful for anyone interested in promoting open source and open science.
  4. Allow user to add commit message interactively
    • You'll add a feature that allows a user to interactively enter a commit message (i.e. a message that describes what recent changes were made to the code) within R. This is the most technically challenging issue. We could use readline(), but I am also open to using some sort of GUI textbox.
jdblischak commented 4 years ago

@skpurdue closed workflowr Issue https://github.com/jdblischak/workflowr/issues/194 with Pull Request https://github.com/jdblischak/workflowr/pull/202 🎉

@trannhatanh89 closed workflowr Issue https://github.com/jdblischak/workflowr/issues/193 with Pull Request https://github.com/jdblischak/workflowr/pull/200 :tada: