One Paragraph+ describing the project goes here. For example: This is a README template you would use to describe a scientific or data analysis project. Provide an overview of the goals of the project, how data was obtained, and other important details others or you in 6 months should be aware of.
Describe the dataset in more detail here if necessary
Data Contact
List a data contact that can be contacted for inqueries regarding archiving and/or removal of data. Two methods of contact should be left, including one that is outside / external to the current institution.
- Daniel E. Cook danielecook@gmail.com - Contact for inqueries regarding data located in
primary/data/folder. - Expiration Date - YYYYMMDD - Data can be (deleted | archived) <-- choose one
Most scripts / analysis can be left as they often do not take up substantial amounts of space, so it is important to describe in detail how data should be handled.
What are the primary analysis scripts/starting points? How would the analysis be rerun?
Give an example
A step by step series of examples that tell you how to get a development/analysis env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using. It is also worth listing what the requirements are.
List references with links to publications this analysis was used for.
The genetic basis of natural variation in Caenorhabditis elegans telomere length
Cook DE, Zdraljevic S, Tanny RE, Seo B, Riccardi DD, Noble LM, Rockman MV, Alkema MJ, Braendle C, Kammenga JE, Wang J, Kruglyak L, Fe ́ lix MA, Lee J, Andersen EC.
2016. Genetics 204:371–383. DOI: https://doi.org/10.1534/genetics.116. 191148, PMID: 27449056
Details regarding how to contribute. Coding style conventions, use of tests, etc.
Additional notes / precatuions / etc. to make users aware of.
List all authors, their contributions, and how to contact; Preferably an internal and external form of contact.
- Daniel E. Cook - Initial work - danielecook; danielecook@gmail.com
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc