requirements:documentation:index
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
requirements:documentation:index [2019/01/27 19:50] – till | requirements:documentation:index [2020/09/29 16:10] (current) – till | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Documentation ====== | + | {{fa> |
+ | ====== Documentation ====== | ||
//Complete documentation of each processing step// | //Complete documentation of each processing step// | ||
- | | + | <WRAP group> |
- | * This includes references to the exact version(s) of the routines and operating system used. | + | <WRAP column 32px> |
- | * The complete set of parameters for each processing and analysis step needs to be documented, including implicit parameters. | + | <WRAP column 85%> |
+ | | ||
+ | * 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. | ||
+ | </ | ||
+ | </ | ||
+ | Basically all data need to be processed and analysed in one way or other to get insight and draw conclusions. Full reproducibility, | ||
+ | |||
+ | 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 [[..: | ||
+ | |||
+ | |||
+ | \\ | ||
+ | <WRAP half column leftalign>< | ||
+ | <WRAP half column rightalign>< | ||
requirements/documentation/index.1548615015.txt.gz · Last modified: 2019/01/27 19:50 by till