File paths, organization and notebooks #35
Conversation
|
No spelling errors! 🎉 |
|
No broken url errors! 🎉 |
|
No quiz formatting errors! 🎉 |
|
Re-rendered previews from the latest commit:
* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea. Updated at 2024-12-19 with changes from the latest commit b2d31cd |
cansavvy
changed the title
| - Is easy for you and others to find the files you need quickly [@Shapiro2021]. | ||
| - Minimizes the likelihood for errors (like writing over files accidentally) [@Shapiro2021]. | ||
| - Is something maintainable [@Shapiro2021]! | ||
|
|
There was a problem hiding this comment.
idk why but these resources all have question marks in the render preview
There was a problem hiding this comment.
AH shoot I must be missing the references in the bib file. Will look into this.
| ``` | ||
|
|
||
| READMEs stick out in a project and are generally universal signal for new people to the project to start by READing them. GitHub automatically will preview your file called "README.md" when someone comes to the main page of your repository which further encourages people looking at your project to read the information in your README. | ||
|
|
||
| **Information that should be included in a README:** |
There was a problem hiding this comment.
Maybe include who is involved in the project or who to contact? (I imagine some people will not be on GitHub)
There was a problem hiding this comment.
Maybe we should talk about licenses?
There was a problem hiding this comment.
added something below!
05-setting-up.Rmd
Outdated
| - **Put source scripts and functions in their own directory**. Things that should never need to be called directly by yourself or anyone else. | ||
| - **Put output in its own directories** like `results` and `plots`. | ||
| - **Have a central document (like a README)** that describes the basic information about the analysis and how to re-run it. | ||
| - Make it easy on yourself, **dates aren't necessary**. The computer keeps track of those. |
There was a problem hiding this comment.
Maybe need a bit more info about this... that dates of file updates aren't necessary? if a survey is from 2020 that might be necessary
|
|
||
| - **Make file names informative** to those who don't have knowledge of the project but avoid using spaces, quotes, or unusual characters in your filenames and folders -- these only serve to make reading in files a nightmare in some programs. | ||
| - **Number scripts** in the order that they are run. | ||
| - **Keep like-files together** in their own directory: results tables with other results tables, etc. _Including most importantly keeping raw data separate from processed data or other results!_ |
There was a problem hiding this comment.
maybe could add sub listing for raw data separate from processed data so we can say a bit more about why? (that it helps us keep from overwriting our raw data)
Co-authored-by: Carrie Wright <[email protected]>
Co-authored-by: Carrie Wright <[email protected]>
There was a problem hiding this comment.
OK I read through everything now @cansavvy ! I had some more complicated suggestions with images about paths, happy to discuss these. Looks like we still need to update the bib file too so putting a reminder here :)
…for_Reproducible_Workflows_in_R into cansavvy/setting-up getting remote changes
Co-authored-by: Carrie Wright <[email protected]>
Created an issue about the bib file #37 Going to merge this and then work on the bib file updating in a separate PR to keep this PR from getting too big. |
Purpose/implementation Section
What changes are being implemented in this Pull Request?
Much of this is remixed from other places.
The content is largely here but I will need to review some more.
What was your approach?
Borrowed some stuff from DataTrail and ITN courses but then am tailoring it.
For Quarto/Markdown I describe the Pros and Cons of each, but then keep the markdown as the tutorial and point folks to Quarto should they be interested.
We could also add a section about quarto rendering but I'm hesitant to dive to much into the details because of maintenance concerns. I would rather point people to posit resources for these tutorials and focus in this course on the reproducibility aspects.