search

benmarwick / rrtools

rrtools: Tools for Writing Reproducible Research in R
Other
668 stars 84 forks source link

Add templated README.md to subfolders #135

Open eliocamp opened 3 years ago

eliocamp commented 3 years ago

Inspired by these awesome slides by Danielle Navarro, I was thinking that adding at least bare-bones README.md files to subfolders might nudge people in the right direction.

image

Specifically, I was thinking on the analysis folder and all its subfolders. For example, the data folder could have an explanation of what is in raw_data and derived_data.

benmarwick commented 3 years ago

Thank you for that very interesting suggestion! What could be good text to put in these readme? Some text that is very short, just a few sentences, that would suit a variety of different users would be ideal, I think. Would you like to draft the text of these in a post to this issue thread so we can discuss and revise further?

wolass commented 3 years ago

I think It could intertwine with issue #86.

If we decide on a more structured analysis we would automatically know how to guide people better by creating README or MAN pages or any other form of support for the analysis.

As I see it right now there is a gap between the paper writing process - which rrtools handles well, and the analysis process - which we assume the user of the package should do themselves and level them to it. In my opinion, we should assist in this initial step a bit more...