Description

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

Input

name:type
description
pattern

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

name:type
description
pattern

loom

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

versions_velocyto

${task.process}

:string

The name of the process

velocyto

:string

The name of the tool

velocyto --version | sed 's/^.*version //'

:eval

The expression to obtain the version of the tool

Topics

name:type
description
pattern

versions

${task.process}

:string

The name of the process

velocyto

:string

The name of the tool

velocyto --version | sed 's/^.*version //'

:eval

The expression to obtain the version of the tool