Skip to content

Commit 2bd8d0e

Browse files
authored
Update README.md
1 parent 8313df7 commit 2bd8d0e

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
# example-repository
2-
This is an example of how our lab currently formats our repositories when starting a new project. If you have suggestions, feel free to open an issue on this repository or bring it up to your labmates!
1+
# Example Repository
2+
3+
This is an example of how our lab currently formats our repositories when starting a new project. If you have suggestions, feel free to open an issue on this repository or bring it up to your labmates. When starting a new project, this repository can act as a reference for how you can set up your files/folders for transparency and reproducibility. [Here](https://docs.google.com/presentation/d/1qNSQs6oabN3tkMpMR_FVOtVCCRRO2qs-87AV3IgE2-o/edit#slide=id.p) is a link to one of our lab meeting presentations about the importance and justification for organizing our data and code in this way.
4+
5+
## Folders:
6+
`script`
7+
This folder contains all the R scripts (or other languages) necessary to reproduce our analyses. Optionally, you can add a separate folder for local functions if it helps you keep things organized.
8+
9+
`graphics`
10+
This folder contains all the graphics and figures produced during the analysis.
11+
12+
`input`
13+
This folder and all folders within contain the _raw_ data used in analysis. The data in this folder should not be altered in any way. It should be read into R, manipulated, and saved in the `large/` or `output/` folders.
14+
15+
`large`
16+
This is a folder that is not tracked by GitHub (and therefore won't show up here) but contains folders too large to push to GitHub, or contains intermediate files that do not need to be pushed to the final repository.
17+
18+
`output`
19+
This folder contains all the output and final, cleaned datasets from our analysis.
20+
21+
## Ongoing Projects
22+
Check out the other repositories for ongoing or completed projects by past/current ZULE members

0 commit comments

Comments
 (0)