Document datasets in a README file
A README file is a way of documenting your research data at data set level, and can be regarded as a complement to your data management plan. While a data management plan is concerned with how data is used in a research project, a README file describes the content of a data set.
The README file documents and describes the content of a data set
A README file provides a structured description of a data set and is a simple way to facilitate the understanding and use of the data. This applies both during the project and afterwards, for the project participants and for others who may be interested. The description is to provide details of who, what, when, where, why as well as how data has been generated in the study, so that it is clear how the data can be used in other contexts and in other disciplines.
The README file must be easy to find and read without special software, so a good method is to save it alongside the data set as a pure text file.
Many data repositories recommend that published data sets include README files, to make it as simple as possible for others to access and potentially reuse your data.
What a README file is to include
A README file must document:
- How data and other files are organised.
- How data has been generated and analysed.
- What possible restrictions exist that may affect how data can be reused.
- Which standards are used in data files and documentation.
How to use a README file
Use the template below to create a README file. Use the parts of the template that are relevant and add headings that make it more easily understood. Then save it at the top of the folder structure as pure text (in the format .txt). It is important that the file is named README (i.e. saved under that name). Write the document in English to enable as many people as possible to understand and use it. If the folder contains subfolders of data sets, it is a good idea to create a README file for each data set. Update the information in the file continuously.
Contact
You can get advice and guidance on research data management from the University's joint research data support team. The support team includes:
- Faculty Data Stewards
- Faculty Library Research Support
- Archivists.
Submit your question (web form)
Email: support [at] researchdata [dot] lu [dot] se (support[at]researchdata[dot]lu[dot]se)
Template for README file in .txt format
Use this README file template when documenting your research data.
How to prepare data (SND.se)
SND has produced a guide to preparing research data.
Data management plan
Remember to continuously update your data management plan.