With thanks to the Bahlai lab for the model and inspiration.
General project documentation
- Project components are all hosted in a repository on Github in the pinskylab organization.
- Declare a license in the README so people know how they can use your work (for example CC-BY 4.0)
- README includes project abstract or description
- README includes file navigation within repo, description of file contents
- README includes links to papers, preprints
- README Includes contact information for authors, and if data is proprietary, for data creators
Data used in support of the project must be:
- Saved in an appropriate, non-proprietary format with accompanying metadata
- In a public archive (e.g., the github repo or another public archive), or, if data is proprietary, a 'snapshot' version of the data used in the project must be saved in a private repository accessible to lab members
- Linked and briefly described in the project README
Code used or developed in support of the project must be:
- Well commented and complete
- On Github, in the public project repository
- Described in the README- what does each file do, what language was used, etc
- Tested! can at least one other person (but more is better) make your analysis go on a different computer?
Set up a time to talk with your mentor about:
- What was the best part of being here?
- What did you learn while you were here?
- Did you get the support you needed, or could we have been better at it?
- What can we improve for mentoring someone in your position in the future?
Write-up (for undergrads)
Write up a summary of your work with the following components:
- Goals of the project
- detailed enough that someone could replicate your work
- explain any decisions you made and why
- link to and describe the input data for the project
- link to the project outputs
- include descriptions of metadata, any column headers in data sheets
- Summary of findings
- Potential next steps (could be a starting point for you at a later point or someone else) The write-up can be a markdown document within your repository or a Google Doc. If you use a Google Doc, please link to it from the README within the repository, make sure the settings are such that anyone with the link can access it, and upload a saved pdf version to the repository.