search

datamade / how-to

📚 Doing all sorts of things, the DataMade way
MIT License
86 stars 12 forks source link

research documents for rMarkdown #111

Closed fgregg closed 3 years ago

fgregg commented 3 years ago

Overview

This PR will contains research documents for rMarkdown

Handles #21

Testing Instructions

fgregg commented 3 years ago

@jeancochrane @hancush, i think this is ready for review and discussion.

fgregg commented 3 years ago

These docs make a strong case for RMarkdown over our existing toolkit for data analysis. Thanks for sharing!

Reading through the docs, it strikes me that the relevant change recommended here isn't exclusively swapping RMarkdown in for Pweave but rather changing up our whole workflow and tooling for reproducible data analysis. I think that effort makes sense, but it has two implications for me:

1. We'll need to plan to do a major edit of https://github.com/datamade/data-analysis-guidelines and bring it into this repo, ideally with some templates (I hear Courts has some cookiecutter templates already?)

2. It would be more appropriate for these docs to live in whatever subdirectory the data analysis docs do, e.g. something like `data-analysis/` instead of `rmarkdown/`

We can do 2 immediately in this PR but I think 1 will be a big task that could take several cycles to accomplish. I expect it'll be hard for you to execute alone given your capacity constraints. As part of pulling this in, we should make a plan for how that work is going to be tracked and delegated, since updated documentation is going to be key to the success of the adoption of this workflow.

I think this makes sense, I propose that we bring in this PR (once I resolve some of the inline comments) and then I can open an an issue on https://github.com/datamade/data-analysis-guidelines to track the changes that need to be made there.

how does that sound @hancush ?

hancush commented 3 years ago

Follow up Q: Does RMarkdown obviate the need for us to learn LaTeX????

hancush commented 3 years ago

Update: We chatted out loud at R&D. We are going to archive the data analysis guidelines and maintain our revised docs, including these artifacts, in how-to/data-analysis. So, action items:

fgregg commented 3 years ago

I think this responds to your requested changes?

hancush commented 3 years ago

It's a new day at DataMade! Thank you, @fgregg.