nf-core / nf-core/modules

[MODULE] velocyto.py module for nf-core/scrnaseq

Open
#5,210 2 comments 0 reactions 1 assignee View on GitHub

@tucano is already working on this.

Since Mar 18, 2024.

Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Velocyto is a library for the analysis of RNA velocity.

I want to implement a module to run velocyto.py inside the scrnaseq pipeline.

Velocyto is tricky beacause it wants to link files and break a little the nextflow paradigms.

My actual solution is to stage copy input files instead of linking.

stageInMode 'copy'

This is due to the fact that velocyto.py command line use: Path(resolve_path=True) and breaks the nextflow logic of symbolic links.

Input file must be cellsorted.

To avoid running samtools sort FROM velocyto we need to create a file with:
samtools sort -t CB -O BAM -o cellsorted_possorted_genome_bam.bam possorted_genome_bam.bam

If velocyto.py in the work dir find a file named EXACTLY cellsorted_[ORIGINALBAMNAME] it will skip the samtools sort step.

THIS IS WHY I NEED TO HAVE IN work dir a file cellsorted_ in the same dir

reference: https://velocyto.org/velocyto.py/tutorial/cli.html#notes-on-first-runtime-and-parallelization

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.