A readme file provides information about a data file and is intended to help ensure that the data can be correctly interpreted, by yourself at a later date or by others when sharing or publishing data. Standards-based metadata is generally preferable, but where no appropriate standard exists, for internal use, writing “readme” style metadata is an appropriate strategy.
Want a template? Download one and adapt* it for your own data!
- Best practices
- Recommended content
- Related information
Create readme files for logical "clusters" of related files / data. In many cases it will be appropriate to create one document for a dataset that has multiple, related, similarly formatted files, or files that are logically grouped together for use (e.g. a collection of Matlab scripts). Sometimes it may make sense to create a readme for a single data file.
Name the readme so that it is easily associated with the data file(s) it describes.
Write your readme document as a plain text file, avoiding proprietary formats such as MS Word whenever possible. Format the readme document so it is easy to understand (e.g. separate important pieces of information with blank lines, rather than having all the information in one long paragraph).
Format multiple readme files identically. Present the information in the same order, using the same terminology.
Use standardized date formats. Suggested format: W3C/ISO 8601 date standard, which specifies the international standard notation of YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.
Follow the scientific conventions for your discipline for taxonomic, geospatial and geologic names and keywords. Whenever possible, use terms from standardized taxonomies and vocabularies, a few of which are listed below.
|Getty Research Institute Vocabularies||geographic names, art & architecture, cultural objects, artist names||http://www.getty.edu/research/tools/vocabularies/|
|Integrated Taxonomic Information System||taxonomic information on plants, animals, fungi, microbes||http://www.itis.gov/|
|NASA Thesauri||engineering, physics, astronomy, astrophysics, planetary science, Earth sciences, biological sciences||https://www.sti.nasa.gov/nasa-thesaurus/|
|GCMD Keywords||Earth & climate sciences, instruments, sensors, services, data centers, etc.||https://earthdata.nasa.gov/earth-observation-data/find-data/gcmd/gcmd-keywords|
|The Gene Ontology Vocabulary||gene product characteristics, gene product annotation||http://amigo.geneontology.org/amigo/dd_browse|
|USGS Thesauri||agriculture, forest, fisheries, Earth sciences, life sciences, engineering, planetary sciences, social sciences etc.||https://www1.usgs.gov/csas/biocomplexity_thesaurus/index.html|
|IUPAC Gold Book||compendium of chemical terminology from the International Union of Pure and Applied Chemistry (IUPAC)||https://goldbook.iupac.org|
Recommended minimum content for data re-use is in bold.
- Provide a title for the dataset
- Name/institution/address/email information for
- Principal investigator (or person responsible for collecting the data)
- Associate or co-investigators
- Contact person for questions
- Date of data collection (can be a single date, or a range)
- Information about geographic location of data collection
- Keywords used to describe the data topic
- Language information
- Information about funding sources that supported the collection of the data
Data and file overview
- For each filename, a short description of what data it contains
- Format of the file if not obvious from the file name
- If the data set includes multiple files that relate to one another, the relationship between the files or a description of the file structure that holds them (possible terminology might include "dataset" or "study" or "data package")
- Date that the file was created
- Date(s) that the file(s) was updated (versioned) and the nature of the update(s), if applicable
- Information about related data collected but that is not in the described dataset
Sharing and access information
- Licenses or restrictions placed on the data
- Links to publications that cite or use the data
- Links to other publicly accessible locations of the data (see best practices for sharing data for more information about identifying repositories)
- Recommended citation for the data (see best practices for data citation)
- Description of methods for data collection or generation (include links or references to publications or other documentation containing experimental design or protocols used)
- Description of methods used for data processing (describe how the data were generated from the raw or collected data)
- Any software or instrument-specific information needed to understand or interpret the data, including software and hardware version numbers
- Standards and calibration information, if appropriate
- Describe any quality-assurance procedures performed on the data
- Definitions of codes or symbols used to note or characterize low quality/questionable/outliers that people should be aware of
- People involved with sample collection, processing, analysis and/or submission
*Repeat this section as needed for each dataset (or file, as appropriate)*
- Count of number of variables, and number of cases or rows
- Variable list, including full names and definitions (spell out abbreviated words) of column headings for tabular data
- Units of measurement
- Definitions for codes or symbols used to record missing data
- Specialized formats or other abbreviations used
Want a template? Download one and adapt it for your own data!
The preceding guidelines have been adapted from several sources, including:
Best practices for creating reusable data publications (2019). Dryad.
Introduction to Ecological Metadata Language (EML) (2012). The Knowledge Network for Biocomplexity.
- Document and Store Data Using Stable File Formats (DataONE): Provides useful information about file formats.
- File formats (RDMSG)
- File management (RDMSG)
- Introduction to Intellectual Property Rights in Data Management (RDMSG)
- Metadata and Describing Data (RDMSG)
* Our Readme metadata template is shared under a Creative Commons 1.0 Universal Public Domain Dedication (CC0 1.0). Please adapt, use and share as you see fit; attribution is appreciated when re-sharing, but not required!