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…
Credibility, confidence and collaborative focus: The impact of studying for a sustainability apprenticeship at Cranfield
For participants on Cranfield’s Sustainability Business Specialist Apprenticeship, it doesn’t take long for their studies to start to have an impact, with that impact ranging from personal growth and career progression, to organisational effect ...
Meet Mendeley: a powerful referencing tool that does the hard work for you!
Are you looking for a way to manage your references, create in-text citations and reference lists for your assignments or thesis? If so, you may wish to consider using Mendeley. What is it? Mendeley is ...
Adding documents to your Mendeley account
To make the most of a Mendeley account, it is useful to create and maintain a ‘Library’ of references. You can add references and documents to this Library in a number of ways: 1) Drag ...
Choosing the right reference management tool for you…
Are you thinking about using reference management software to help you manage your references? The Library is here to help you. While Mendeley has been our go-to reference management software for some years, we've recently ...
Cranfield Seed Fund recipient, Cosysense, are using AI to solve air conditioning problems and provide a net zero alternative
If you’ve ever worked in an office environment you’ve probably been involved in, or overheard, a conversation about the air conditioning. Well, it’s no surprise it’s a common complaint when research shows that up ...
An Eye-Opening Journey in Advanced GIS & Remote Sensing at Cranfield University
My experience in the Advanced GIS and Remote Sensing course at Cranfield University was nothing short of transformational. From day one, the course was designed to provide both technical expertise and real-world applications. What ...