Quality Handbook
- Preparation
- Data collection
- Data Processing
- Data analysis
- Finishing
- Practical items
- Project audits
Data analysis documentation
- Description
- Details
- References
- Definitions
- Amendments
- Audit Questions
Aim
To ensure that the analyses can be properly reproduced.
Description
It is important in respect of reproducibility and efficiency of data analysis that clear documentation of the data analysis takes place. This may be undertaken by creating a text file for all the relevant analyses, for instance in Word. This text file needs to include both the relevant control file (with clear information about all the steps taken), as well as the output (with clear information for all results). The text file needs to start off with the research question to be answered and the date of the analysis, and should end with a(n) (provisional) answer to the question.
See details for an example.SPSS syntax can be used to document your analyses (e.g. for an article) to allow you and others to easily retrieve and reproduce everything. Text can be included in syntax files (as a kind of analysis logbook). Place your analysis in a logical order (e.g. firstly all the analyses for table 1, then table 2, etc.). Don’t forget to always include get/file, so you know which file is related to your analysis (and where they are stored). A Dutch example of this can be found here.
Tip: A PDF writer can be used to store the output in PDF format. This saves on paper.
V1.1: 1 Jan 2010: English translation
V1.0: 21 Apr 2004: Title modified: Documentation instead of Report. Adding details with example of documented syntax.
Does the data documentation for the analysis contain the following elements: Research question, control file with clear explanations, output with clear explanations and an answer to the research question?