Project Organization

MSSL tackles complex problems with a team-based approach. As such, it is important to keep projects organized in a way that everyone on the team knows where everything is. This page describes MSSL's system for project organization.

Repository website

• Wiki - The wiki homepage should include a roadmap for the project. New pages should be added to store and organize information that doesn't belong elsewhere.
• Slides - MSSL uses Google Slides to create presentations to share our progress. We recommend creating one slide deck that gives an overview of the entire project, and additional presentations that goes into detail of project segments as useful. The wiki should have links to editable versions of any presentations (click share, set to "Anyone with the link can edit", and copy that link).
• Issues - The issue tab should be used to create issue tickets around anything that needs action including data coding, code writing, analysis, paper writing, and administrative support. You can use individual or team tags to call targeted attention to the issue and labels to help organize tickets.

Repository folders

Most of our work is organized into three folders:

• R - R functions, with each function having its own .R file
• docs - Documentation files, especially Rmarkdown (.rmd) files that incorporate R code.
• paper - Files for developed papers for sharing or submission, including .tex/.lyx files, .bib files, etc.
• data - Small datasets you create and use during the project that would ok to go public. Large files that are over 100MB or are proprietary or otherwise private should not be saved in Github. See Storing Data.

Additional folders may be used for some projects:

• inst - Installed files. We use inst/extdata for small datasets from external sources that are used in the project. Large files that are over 100MB or are proprietary or otherwise private should not be saved in Github. See Storing Data.
• src - source files
• man - manual pages for your functions
• tests - automated tests