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…
Changes to FitchConnect…
Those of you who have been using FitchConnect may have noticed that things are changing. The BMI content we subscribe to being migrated to its own platform. In the meantime, when you login to Fitch, ...
Love in the first degree – Management MSc students plan to get married!
After meeting at Cranfield whilst studying Management MSc, Isabel and Vatsal share their fond memories of Cranfield and what the future holds. Tell us about yourself Isabel: My name is Isabel Hamm and I'm originally ...
Our Cardiff study tour – an incredible experience that goes beyond academic learning
My name is Hyelni David Malgwi, originally from Nigeria. I am currently pursuing a master’s in Logistics and Supply Chain Management. I recently had the fantastic opportunity to participate in a study tour to Cardiff, ...
Air Transport Management MSc student Quentin Lacoste on studying at Cranfield and his exciting new job role
Quentin Lacoste is studying for an MSc in Air Transport Management (ATM). Here, he talks about his journey to Cranfield, his experience on the course, and his exciting new job offer. ...
Advancing Uncrewed Aerial Systems: My Journey at Cranfield University
Cranfield University has offered me countless opportunities in the short time I have been here, and I am committed to making the most of them. As an expert in drones and ...
How we’re helping the UK take back control of time
Our lives run on the supply of an invisible utility: accurate time. Starting with the morning alarm on our smartphone, it’s the basis of the everyday information we rely on for travel schedules, journey ...