README Metadata Template

This readme file was generated on [YYYY-MM-DD] by [NAME]
[Note: help text in brackets should be replaced with suggested information and deleted before finalizing your document]


GENERAL INFORMATION

Title of Dataset: [provide at least two contacts]

Author/Principal Investigator Information
Name:
ORCID:
Institution:
Address:
Email:

Author/Associate or Co-investigator Information
Name:
ORCID:
Institution:
Address:
Email:


- Date of data collection: [provide single date, range, or approximate date; suggested format YYYY-MM-DD]
- Geographic location of data collection: [provide latitude, longitude, or city/region, State, Country]
- Information about funding sources that supported the collection of the data:


SHARING/ACCESS INFORMATION

- Licenses/restrictions placed on the data:
- Links to publications that cite or use the data:
- Links to other publicly accessible locations of the data:
- Links/relationships to ancillary data sets:
- Was data derived from another source?
	- If yes, list source(s):
- Recommended citation for this dataset:


DATA & FILE OVERVIEW

File List: [list all files (or folders, as appropriate for dataset organization) contained in the dataset, with a brief description]

- Relationship between files, if important:
- Additional related data collected that was not included in the current data package:
- Are there multiple versions of the dataset?
	- If yes, name of file(s) that was updated:
	- Why was the file updated?
	- When was the file updated?


METHODOLOGICAL INFORMATION

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]

Methods for processing the data:
[describe how the submitted data were generated from the raw or collected data]

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]

[include any additional methodological information needed to interpret and/or use the data, as appropriate]
- Standards and calibration information, if appropriate:
- Environmental/experimental conditions:
- Describe any quality-assurance procedures performed on the data:
- People involved with sample collection, processing, analysis and/or submission:


DATA-SPECIFIC INFORMATION FOR: [FILENAME]
[repeat this section for each dataset, folder or file, as appropriate]

- Number of variables:
- Number of cases/rows:
- Variable List: [list variable name(s), description(s), unit(s) and value labels as appropriate for each]
- Missing data codes: [list code/symbol and definition]
- Specialized formats or other abbreviations used:

CREDITS

Based on a template by Wendy Kozlowski at Cornell University: https://data.research.cornell.edu/data-management/sharing/readme/