5.4.6. Workflow Documentation#
Clearly document the steps taken in the analysis to allow others to understand and replicate the process.
How?
Document the execution workflow in an automation script. E.g., with a simple
run_analysis.sh
, a workflow management tool like snakemake or nextflow, or GitHub Actions .Clarify how the version of the analysis scripts, as well as, the dataset are linked to the execution of the analysis.
Specify how the execution environment is build up.