Course summary¶
Congratulations on completing the Use nf-core training course! 🎉
Your journey¶
You started by finding and retrieving the nf-core/demo pipeline, then learned to run it using its test profile and examine its outputs.
Next, you configured its execution through pipeline parameters and configuration files, and saw how nf-core pipelines validate parameters and input data.
Then you applied those same skills to nf-core/rnaseq, a production-scale pipeline: you pinned it to a specific release, overrode its default resource allocations to fit a small machine, and cancelled a run.
You chose a pipeline for a scientific question by evaluating its documentation and a completed run, prepared samplesheets for your own data and for public data, and diagnosed and fixed samplesheet errors.
Finally, you ran the pipeline on a bigger machine and used its execution report to tune resource allocations.
What you learned¶
You are now able to find, retrieve, run, and configure nf-core pipelines.
- nf-core pipelines are retrieved with
nextflow pulland follow a standard code organization. - Every nf-core pipeline ships with a
testprofile for quick validation on a small dataset. - Pipeline parameters (set via
--param_nameor-params-file) and configuration (set via-c) serve different purposes: inputs and analysis options versus execution logistics like resource allocation. - nf-core pipelines validate parameters and input files automatically, catching errors before any work is done.
- Resource defaults are assigned through labels (
process_low,process_medium,process_high) defined inconf/base.config, which you can override with a custom configuration file. - Samplesheet requirements are documented in the usage docs and enforced by the input schema (
assets/schema_input.json); some pipelines add their own checks across rows. -previewand-stublet you check inputs without running the full analysis.- Choosing a pipeline starts with defining the result you need, then checking that a candidate produces it from the inputs you have.
- Execution reports show how much of its allocation each process actually used, which tells you how to right-size resources.
- Over-allocated resources limit how many tasks can run in parallel;
resourceLimitscaps requests at what the machine provides. - When you override resource values, keep the
task.attemptmultiplier so that failed tasks are retried with more resources.
Skills acquired¶
Through this hands-on course, you've learned how to:
- Find an nf-core pipeline on the nf-co.re website and retrieve its source code
- Run a pipeline using its built-in test profile and examine its outputs
- Get help, set parameters, and understand parameter and input validation
- Customize resource allocation and tool arguments through configuration files
- Pull and run a production-scale pipeline pinned to a specific release with
-r, and override its default resource allocations by label and by process name - Cancel a run cleanly with Ctrl+C (or
killfor a background run) - Find and evaluate pipelines for a specific scientific question
- Write a samplesheet for your own data, including samples sequenced on multiple lanes
- Generate a samplesheet for public data with
nf-core/fetchngs - Diagnose and fix input validation errors
- Run a pipeline with more compute resources by changing the machine type
- Tune resource allocations based on the execution report
You're now equipped with the foundational knowledge to start running nf-core pipelines for your own analyses.
Next steps to build your skills¶
Here are our top suggestions for what to do next:
- Launch and monitor these pipelines at scale with Scale with Seqera
- Don't just run nf-core pipelines, develop them! Learn nf-core best practices with Build with nf-core
- Want to write your own pipelines? Start with Hello Nextflow
- Apply Nextflow to a scientific analysis use case with Nextflow for Science
- Explore more advanced Nextflow features with the Side Quests
Getting help¶
For help resources and community support, see the Help page.
Feedback survey¶
Before you move on, please take a minute to complete the course survey! Your feedback helps us improve our training materials for everyone.