Quick Start¶
Prerequisites¶
- Docker installed on your system
- Git for cloning the repository
Setup Steps¶
1. Clone the Repository¶
Download the repository:
Important!
Make sure that the pipeline data is in the
data/inputsfolder.
2. Start the Docker Container¶
Important!
Create a configuration file
config.jsonbased on data indata/inputs.
3. Run Input Validation¶
Running QC on the input data and processing data for the Nextflow pipeline to data/valid folder:
validate # default config (./data/inputs/config.json)
validate --config <path> # custom config path
# Optional global option flags (config.json takes priority when both are set):
validate --threads <n|auto> # number of threads, or 'auto'
validate --validation-level <level> # strict / trust / minimal
validate --logging-level <level> # DEBUG / INFO / WARNING / ERROR
validate --type <type> # prokaryote / eukaryote
validate --force-defragment-ref # unsupported workaround, at your own responsibility
# ignored if force_defragment_ref is set in config.json
4. Execute the Pipeline¶
Start the pipeline:
Next Steps¶
- Learn more about Docker Setup
- Configure your Validation Settings
- Understand Pipeline Execution