Reproducible-Research.de

Concepts and tools for the responsible scientist

User Tools

Site Tools


requirements:documentation:index

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
requirements:documentation:index [2019/01/27 18:59] – created tillrequirements:documentation:index [2020/09/29 16:10] (current) till
Line 1: Line 1:
-====== Documentation ======+{{fa>file-text?48&align=right}} 
 + ====== Documentation ======
  
 //Complete documentation of each processing step// //Complete documentation of each processing step//
  
 +<WRAP group>
 +<WRAP column 32px>{{fa>key?32}}</WRAP>
 +<WRAP column 85%>
 +  * To be reproducible, each and every processing and analysis step\\ performed on data needs to be documented.
 +  * This includes references to the exact version(s)\\ of the routines and operating system used.
 +  * The complete set of parameters for each processing and analysis step\\ needs to be documented, including implicit parameters.
 +</WRAP>
 +</WRAP>
 +
 +Basically all data need to be processed and analysed in one way or other to get insight and draw conclusions. Full reproducibility, hence, requires a **gap-less record** of each and every processing and analysis step starting with the raw data and ending with the published figure or table.
 +
 +With most data nowadays obtained digitally, the amount of data is growing exponentially as well, rendering manual tracing of processing and analysis steps nearly hopeless. Therefore, a s**ystem that automatically saves the metadata** of each processing and analysis step seems to be the only choice.
 +
 +These metadata need to include references to the exact version(s) of the routines and the operating system used, as well as a complete set of parameters for each processing and analysis step. The latter needs to include implicit parameters as well, as they may change over time. Impliicit parameteres refer here to parameters usually set to (default) values within the routine, not requiring explicit user input.
 +
 +For details on versioning of routines, see the respective requirements section on [[..:versioning:|versioning]].
 +
 +
 +\\
 +<WRAP half column leftalign><WRAP button>[[..:archiving:|← Archiving]]</WRAP></WRAP>
 +<WRAP half column rightalign><WRAP button>[[..:versioning:|Versioning →]]</WRAP></WRAP>
  
requirements/documentation/index.1548611946.txt.gz · Last modified: 2019/01/27 18:59 by till