×

nf-core/velocyto @ 0.0.0-0c7146d

Velocyto is a library for the analysis of RNA velocity. velocyto.py CLI use Path(resolve_path=True) and breaks the nextflow logic of symbolic links. If in the work dir velocyto find a file named EXACTLY cellsorted_[ORIGINAL_BAM_NAME] it will skip the samtools sort step. Cellsorted bam file should be cell sorted with:

    samtools sort -t CB -O BAM -o cellsorted_input.bam input.bam

See module test for an example with the SAMTOOLS_SORT nf-core module. Config example to cellsort input bam using SAMTOOLS_SORT:

    withName: SAMTOOLS_SORT {
        ext.prefix = { "cellsorted_${bam.baseName}" }
        ext.args = '-t CB -O BAM'
    }

Optional mask must be passed with ext.args and option --mask This is why I need to stage in the work dir 2 bam files (cellsorted and original). See also velocyto tutorial

Latest version: 0.0.0-6c4ed3a
Total downloads: 9
Source: nf-core/modules
Authors: @tucano
Maintainers: @tucano

Summary

Velocyto is a library for the analysis of RNA velocity. velocyto.py CLI use Path(resolve_path=True) and breaks the nextflow logic of symbolic links. If in the work dir velocyto find a file named EXACTLY cellsorted_[ORIGINAL_BAM_NAME] it will skip the samtools sort step. Cellsorted bam file should be cell sorted with:

    samtools sort -t CB -O BAM -o cellsorted_input.bam input.bam

See module test for an example with the SAMTOOLS_SORT nf-core module. Config example to cellsort input bam using SAMTOOLS_SORT:

    withName: SAMTOOLS_SORT {
        ext.prefix = { "cellsorted_${bam.baseName}" }
        ext.args = '-t CB -O BAM'
    }

Optional mask must be passed with ext.args and option --mask This is why I need to stage in the work dir 2 bam files (cellsorted and original). See also velocyto tutorial

Get started

Add the following snippet to your workflow script to include this module.

include { VELOCYTO } from 'nf-core/velocyto'

License

MIT License

Process
Name VELOCYTO
Input 2 channels
#1 tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

barcodes file

Valid barcodes file, to filter the bam

*.tsv.gz
bam file

Sorted BAM/CRAM/SAM file

*.{bam,cram,sam}
sorted_bam file

Cell sorted BAM/CRAM/SAM file generated with samtools sort -t CB -O BAM -o cellsorted_possorted_genome_bam.bam possorted_genome_bam.bam

*.bam
gtf file

genome annotation file

*.gtf
Output 2 channels
#1 loom tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

*.loom file

Loom file with counts divided in spliced/unspliced/ambiguous.

*.loom
*.velocyto.log file

Loom file with counts divided in spliced/unspliced/ambiguous.

*.loom
#2 versions
versions.yml file

File containing software versions

versions.yml
Tool Description Homepage
velocyto A library for the analysis of RNA velocity. https://github.com/velocyto-team/velocyto.py
Version 0.0.0-0c7146d
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 08 Apr 2026 19:46:35 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Fvelocyto/0.0.0-0c7146d/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/velocyto/blobs/sha256:1b1379602240fabf31f04601f3d71f56b2903f403d9cf2c7a6bbdf6b0b798100
Size 3.3 KB
Checksum sha256:1b1379602240fabf31f04601f3d71f56b2903f403d9cf2c7a6bbdf6b0b798100
Downloads 3
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:52:18 (UTC) 3 3.3 KB
0.0.0-3fc6d40 22 Apr 2026 15:36:12 (UTC) 3 3.3 KB
0.0.0-0c7146d 08 Apr 2026 19:46:35 (UTC) 3 3.3 KB