Data documentation – what and why
22/09/2016
Just as a map becomes much easier to read when you have a legend explaining the symbols, data is much easier to comprehend when you have descriptive and contextual information. For example, while you’re using your research data, you’ll know what your variable names are short for, and what different missing value codes mean. But if you want to reuse it in a few years’ time, will you still be certain? Or if another researcher uses your data, will they be able to understand it without needing to ask you questions? Maybe you’ve experienced frustration yourself, when you want to incorporate existing data into your research, but it wasn’t made available with sufficient information and you’ve had to spend time contacting the creator.
Making documentation available alongside your data is therefore a key step to ensuring its long-term usability and value, both for you and others (which might lead to extra citations). Documentation can be as simple as one text file, in which you’ve noted all the key contextual information about the data and the project. Some elements you might want to include are:
- Study-level information
- Data collection methods, such as instruments used, sampling methods, scales, geographic/temporal coverage, etc.
- Data processing methods, such as validation, checking, cleaning, calibration procedures, etc.
- Data-level information
- Names, labels, descriptions, and units for all variables and fields.
- Explanation of codes, including reasons for missing values (not applicable/not provided/not recorded/error/etc).
With data-level information, you may be able to include enough information in the data files themselves (e.g. in table headings in a spreadsheet). Otherwise, you might want to store a separate explanatory file alongside your data file(s). You could use our template readme.txt file to note all the necessary elements you want to include, perhaps adding to it as you work through the project.
Or you might benefit from writing what’s called a “data dictionary”, basically a legend to your data. This great blog post on data dictionaries explains it in a nutshell, and highlights the benefits, whether sharing data with others (in or outside your project team) or just your future self. And remember that if you’ve entered this information into a tool such as SPSS, you should be able to export it to a file to store with your data (e.g. in SPSS v23, File > Display Data File Information > Working File > print, and print to pdf, or use the File > Export option in many screens to export to a more usable format such as txt).
So, when depositing your data in a repository, remember to include sufficient documentation for others (or your future self!) to understand it so no questions arise.
Image: City map by Mathieu Pellerin, CC-BY-NC-SA 2.0.
Categories & Tags:
Leave a comment on this post:
You might also like…
Systematic Literature Review – Identifying your search terms and constructing your search strings
Our previous posts on the systematic review have looked at getting started and selecting your sources. In this post we will look at the next fundamental stage: Identifying your search terms and constructing your search ...
Navigating the World of Robotics: My Journey at Cranfield University
Hey there, I'm Manideep, and I'm thrilled to share my experience pursuing an MSc in Robotics at Cranfield University. Let me take you through my journey and how Cranfield became the ...
Exploring safer and smarter airports with the Applied Artificial Intelligence MSc group design project
Artificial intelligence (AI) technologies have experienced rapid development in recent years, spanning from large language models (LLMs) to generative artificial intelligence (GAI). These cutting-edge advancements have significantly impacted various aspects of ...
My aerospace manufacturing journey at Cranfield University
Hey there, I'm Abhishek and I wanted to share my journey into aerospace manufacturing, guided by my experiences at Cranfield University. Let's dive into how this remarkable institution shaped my career ...
Changes to Library Services over Easter, 29 March – 1 April
Libraries on the Cranfield site Both Kings Norton Library and the School of Management Library (Building 111, first floor) will be open 24/7 over the Easter weekend. You will be able to use the study ...
How to present well as a group
You will have put a lot of work into your research or project and want to show everyone what you have achieved or discovered, so you need to impart this knowledge as clearly as possible. ...