README Template
This DATSETNAMEreadme.txt file was generated on YYYY-MM-DD by NAME
[help text is included in brackets, and can be deleted before saving]
GENERAL INFORMATION
1. Title of Dataset
2. Author Information
A. Principal Investigator Contact Information
Name
Institution
Address
Email
B. Associate or Co-investigator Contact Information
Name
Institution
Address
Email
C. Alternate Contact Information
Name
Institution
Address
Email
3. Date of data collection (single date, range, approximate date) [suggested format YYYY-MM-DD]
4. Geographic location of data collection [latitude, longiute, or city/region, State, Country, as appropriate]
5. Information about funding sources that supported the collection of the data
SHARING/ACCESS INFORMATION
1. Licenses/restrictions placed on the data
2. Links to publications that cite or use the data
3. Links to other publicly accessible locations of the data
4. Links/relationships to ancillary data sets
5. Was data derived from another source? yes/no
A. If yes, list source(s)
6. Recommended citation for this dataset
DATA & FILE OVERVIEW
1. File List
[list all files (or folders, as appropriate for dataset organization) contained in the dataset, with a brief description]
2. Relationship between files, if important
3. Additional related data collected that was not included in the current data package
4. Are there multiple versions of the dataset? yes/no
A. If yes, name of file(s) that was updated
i. Why was the file updated?
ii. When was the file updated?
METHODOLOGICAL INFORMATION
1. Description of methods used for collection/generation of data
[Include links or references to publications or other documentation containing experimental design or protocols used in data collection]
2. Methods for processing the data
<[escribe how the submitted data were generated from the raw or collected data]
3. Instrument- or software-specific information needed to interpret the data
[include full name and version of software, and any necessary packages or libraries needed to run scripts]
4. Standards and calibration information, if appropriate
5. Environmental/experimental conditions
6. Describe any quality-assurance procedures performed on the data
7. People involved with sample collection, processing, analysis and/or submission
DATA-SPECIFIC INFORMATION [Filename]
[repeat this section for each dataset, folder or file, as appropriate]
1. Number of variables
2. Number of cases/rows
3. Variable List
[list variable name(s), description(s), unit(s)and value labels as appropriate for each]
4. Missing data codes
[list code/symbol and definition]
5. Specialized formats or other abbreviations used
CREDITS
Based on a template by Cornell University Research Data Management Service Group: https://data.research.cornell.edu/content/readme