HackMD
  • Prime
    Prime  Full-text search on all paid plans
    Search anywhere and reach everything in a Workspace with Prime plan.
    Got it
      • Create new note
      • Create a note from template
    • Prime  Full-text search on all paid plans
      Prime  Full-text search on all paid plans
      Search anywhere and reach everything in a Workspace with Prime plan.
      Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Gist
    Import
    Dropbox Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # Nextflow materials Contributors Persona 1: Sarah Bonnin, Toni Hermoso Pulido, Renuka Kudva, Tuur Muyldermans, Maxime Garcia Contributors Persona 2: Luca Cozzuto, Jose Espinosa-Carrasco, Maxime Garcia ## Nextflow users (persona 1) Nextflow users (more introductory - concepts why - exercises explaining fundamentals) ### Learner's profiles - Who are they? - Already have some background with bioinformatics data analysis → “Applied” bioinformaticians? - Linux users → they know how to use CLI - Familiarity with git / GitHub advantageous but not strictly required. They can take - for example - the dedicated [Software Carpentry tutorial.](http://swcarpentry.github.io/git-novice/) - What problem are they having? - Big data, or multiple experiments with similar data and/or many data files → automate processes - Want to make their analysis reproducible - How will the tutorial/workshop help them? - Understand conceptually, Understand how to run, debugging - know what which - errors might mean what, resuming/retry, workdir, if process fails → where to find fails (.command./* ), .nextflow.pid - Reproduce failing process from workdir (maybe coupled to run from associated container) ### Learner's objectives - Prerequisites for the course/tutorial - They have some (basic) experience in CLI/Linux, so they are able to run a pipeline and understand what’s happening or tune the parameters etc. <!-- - linux users, Basic knowledge of Linux/command-line. Familiar enough to navigate through the folders, inspect and change files (with nano or any other text-editor of preference), more than just running the literal commands given in the ‘course’. --> - Define exercises with learning outcomes (measurable)* - Describe terminology/different concepts so you can explain to a developer what might need to be changed. (Dataflow) - To be able to find and run different existing pipelines. - Do small trouble-shootings yourself (unrelated to the programming of the pipeline - at the level of config file). - Navigate the workdir and find specific output(files). - Raise issues or reach out to the community *Goals: “After following one of these tutorials, learners will be able to …” ### Training materials Example pipeline: https://github.com/nextflow-io/rnaseq-nf Tutorial based on this pipeline (focus on how to edit & construct the pipeline): https://github.com/cbcrg/nf-phdcourse20 Outline: 1. Introduction nextflow and language (theoretical) - Describe nextflow conceptually and the language. - Describe the concepts of channels, operators, processes, modules. 2. Knowing where to find a pipeline (github, nf-core, ...) and which one to use. - Repositories: - https://github.com/nextflow-io/awesome-nextflow - https://nf-co.re/pipelines - https://github.com/BioContainers/workflows - **Exercise**: find a pipeline doing --- ? 3. Import a pipeline (download/clone locally or from github - but also possible to pull (nextflow pull)) - focus on DSL2 pipelines. https://github.com/nextflow-io/awesome-nextflow - (Exercise difference between `nextflow run/pull` and `git clone`.) The latter is for later when we need to change the profiles in config. * `nextflow run nextflow-io/rnaseq-nf` * `nextflow pull nextflow-io/rnaseq-nf -r v1.2` (Pull a given version) * `nextflow pull nextflow-io/rnaseq-nf -r master` (Pull latest from master branch) * `nextflow pull nextflow-io/rnaseq-nf -r 98ffd10a76` (Pull a given commit) - **Exercise**: nextflow-pull a [specific pipeline](https://github.com/nextflow-io/rnaseq-nf) (they need to find themselves). Extra: define release (or tag/release/commit) 4. Execute a pipeline - Exercise nextflow run `<pipeline>` (toy pipelines = tiny pipelines) + fast, easy, simple. When more familiar → then go to a nf-core pipeline. * `nextflow run nextflow-io/rnaseq-nf` * Side note: If you don't do nextflow pull, so immediately nextflow run, it will also fetch it from the internet (github) * Sidenote: Error: `Command error: .command.sh: line 2: salmon/fastqc/multiqc: command not found`. Due to tools not being installed. Fix with conda or docker. * Conda: `conda env create -f conda.yml` & `conda activate rnaseq-nf` * Docker: (if docker installed): `nextflow run nextflow-io/rnaseq-nf -with-docker` * Singularity: (if Singularity installed): `nextflow run nextflow-io/rnaseq-nf -with-singularity` 5. Locate and describe the output after running a pipeline → workdir with different files (.command.*). - .nextflow.log - Exercise when running the pipeline it created an output. Find where the output was created. - Exercise: go to the directory that contains the outputs of a given step. - Find for that process which command was given to the computer (.command.sh) - Find out which files are present in that folder - Copy-paste one of the outputs from the workdir to another folder (but than know that you can change it with 'publishDir') 6. Run with different parameters: nextflow-specific versus pipeline-specific (- vs --) - Pipeline parameters: change a parameter defined in `params.<name>` on runtime: - Exercise rename output directory - Overwrite reads `nextflow run nextflow-io/rnaseq-nf --reads path/to/reads` (e.g. with only part of the reads: `ggal/ggal_liver_{1,2}.fq`) - Nextflow parameters: - Create reports - Exercise where they create a visual report: (-with-dag) - Exercise where they create a html report (-with-report) - Exercise running with Tower (-with-tower). - Running in the background - Resume pipeline - Exercise delete a workdirectory and see that the pipeline resumes from somewhere else (in the beginning) people should be aware of the fact that it becomes very big. Some pipelines allow you to cp or mv the results inside the directory that you want (there is a parameter/flag for it so not necessary to change it inside the pipeline script). - Showcase the caching - run with a different parameter (file or the file has moved). When the file has moved → different timestamp → different cache. 7. Explain config files and being able to do minor modifications (eg. change version of docker container, parameters like computation power) - Exercise: Run with profile (standard & -with-docker) or (stanExplain config files and being able to do minor modifications dard,docker) or (standard,conda) - Exercise: find where the reads are coming from if you run with amazon. What does it mean if you run it with this profile (it will overrun the parameters defined in the main.nf) - Exercise: Knowing the above --> change the parameters of standard profile so it takes different reads. - Extra exercise - not the focus for this workshop: git clone so they have a pipeline where they can work on / alternatively: create config file that will overwrite the config file. ``` standard { process.container = 'quay.io/nextflow/rnaseq-nf:latest' params.reads = "$baseDir/data/ggal/ggal_liver_{1,2}.fq" } ``` <!-- - Config files: there might be parameters related to running things in the cloud/HPC which you are not allowed to change, but there might be also one related to the pipeline (so more regarding the bioinformatics tools) - Exercise inspect the config file and change a parameter (an easy one) and it should be clear that when you have changed it it gives a different output - profiles: Exercise with different profiles (if possible) --> - Analyze the error/failure of a pipeline - correct it appropriately (if technical is not relevant) - lack of memory and resources, file not found, docker not provided, error related to the tool (find it in the error message of the pipeline or in the workdir : .command.out/err) - One hyphen or two hyphen, wrong dash, file missing, missing parameter. - Exercise: find for that process which command was given to the computer (.command.sh) Extra: - File issue on GitHub (if relevant) or contact community - understand how databases are used within pipeline - containers/singularity? ## Nextflow pipeline developers (persona 2) ### Learner's profiles - Who are they? - bioinformaticians that want to develop using nextflow (both beginners and more advanced) - What problem are they having? - parallelizing, reproducibility, portability etc. - porting pipelines to NF - porting DSL1 to DSL2 - How will the tutorial/workshop help them? - learning basics and pointers with more resources / community etc - they will know a list of useful tools / resources for programming / editing - debugging ### Learner's objectives - Prerequisites for the course/tutorial - linux users, bash, CLI, know a programming language, git / GitHub is strongly recommended - containers - Define exercises with learning outcomes (measurable)* - Channel, Process and Workflow (To learn Nextflow DSL2) - Switching to DSL2 (For users already knowing Nextflow) - Assembling (sub)workflows - Configuration (To help with controlling the resource, parameters) - Change docker/conda/singularity - know what they can change - Debug (With some examples. To help users understanding the logic and the mindset) *Goals: “After following one of these tutorials, learners will be able to …” ### Training materials Outline: - Recognize that reproducibility is an advantage - (-> using a workflow manager makes a pipeline reproducible and save time) - (-> using containers) - Remember Reproducibility - (Why we use workflow managers, NO MORE BASH SCRIPTS) - Understand dataflow programming model - Use configuration files (or profile) - Analyze what is causing an issue/bug, and where it’s coming from - Design their own pipeline ## Contribution notes This Markdown-file can be collaboratively and simultaneously edited from [this link](https://hackmd.io/@tmuylder/S1B8dzFWO/edit). Please push to the branch `nextflow` in order not to make conflicting versions. This is automatically done when you push the Hackmd-file to GitHub (click on Settings... right top --> Versions and GitHub Sync --> Push). However, might only be done by @tmuylder.

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully