rr-organization1
The Organization lesson for the Reproducible Science Curriculum
Science Score: 31.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 8 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.2%) to scientific vocabulary
Keywords
Repository
The Organization lesson for the Reproducible Science Curriculum
Basic Info
- Host: GitHub
- Owner: datacarpentry
- License: other
- Language: HTML
- Default Branch: gh-pages
- Homepage: http://www.datacarpentry.org/rr-organization1/
- Size: 81.4 MB
Statistics
- Stars: 36
- Watchers: 17
- Forks: 20
- Open Issues: 7
- Releases: 0
Topics
Metadata Files
README.md
Organization 1
Overview and learning objectives
Students will learn the benefits of project and folder organization, and how these enable reproducibility and reusability. They will then complete an activity where they use provided examples to set up the structure and naming conventions for a new project.
At the end of the session students will be able to
- Evaluate folder and file structure of a project.
- Recognize common problems that occur in file organization.
- Distinguish between input and output files.
- Setup up a new project with a structure that facilitates reproducibility
Materials
- organization slides:
slides/organization-slides - file naming slides:
slides/naming-slides - Lesson:
organization-01-lesson.md - Instructor notes:
organization-01-instr-notes.md
Resources and useful links
Relevant scientific papers
- EP White, E Baldridge, ZT Brym, KJ Locey, DJ McGlinn, SR Supp (2013) "Nine simple ways to make it easier to (re)use your data." Ideas in Ecology and Evolution 6(2): 1–10, 2013. doi:10.4033/iee.2013.6b.6.f (in particular the section "Use standard table formats")
- WS Noble (2009) "A Quick Guide to Organizing Computational Biology Projects." PLoS Computational Biology 5 (7): e1000424. doi:10.1371/journal.pcbi.1000424
File naming and organization
- File naming guides and suggestions from
- Wikipedia entry on list of filename extensions
- Wikipedia entry on ISO 8601 standard for dates
People and credits
This lesson was first created at the 1. Reproducible Science Curriculum Hackathon. The corresponding author is Ciera Martinez @iamciera. See the commit log for other contributors.
Please post feedback and issues with the lesson on the repository's issue tracker. For instructor questions about teaching this lesson, you can also contact the corresponding author directly.
Owner
- Name: Data Carpentry
- Login: datacarpentry
- Kind: organization
- Email: team@carpentries.org
- Website: https://datacarpentry.org/
- Repositories: 89
- Profile: https://github.com/datacarpentry
Workshops teaching scientists basic skills for retrieving, viewing, managing, and manipulating data in an open and reproducible way.
Citation (CITATION)
Please cite this lesson as: Data Carpentry Reproducible Research Committee. 2016. "File organization for reproducible research." https://github.com/data-carpentry/rr-organization1 zenodo DOI to follow.
GitHub Events
Total
- Watch event: 3
- Fork event: 2
Last Year
- Watch event: 3
- Fork event: 2