Skip to content

Conversation

@FriederikeHanssen
Copy link
Contributor

requires nf-core/test-datasets#1830

This PR adds Nirvana, an annotation tool developped by Illumina

PR checklist

Closes #XXX

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

@FriederikeHanssen FriederikeHanssen marked this pull request as ready for review January 9, 2026 22:57
@jonasscheid
Copy link
Contributor

LGTM, only fix linter complains :)

@FriederikeHanssen
Copy link
Contributor Author

Somehow the Singularity container does not work. It has Nirvana not in the path and is missing some dotnet symlink :confused_husky:

not sure why, given that both the conda recipe and docker container work

Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jonasscheid
Copy link
Contributor

I wanted to suggest using the galaxy container, but there is none. Also not on quay. But why is nirvana in bioconda but not quay/galaxy 🤔

input:
tuple val(meta), path(vcf)
tuple val(meta2), path(reference)
tuple val(meta3), path(cache), val(cache_prefix)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the cache_prefix a path or a specific string within the path?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the data looks like this:

❯ tree
.
├── Cache
│   └── SARS-CoV-2
│       ├── SARS-CoV-2.polyphen.ndb
│       ├── SARS-CoV-2.sift.ndb
│       └── SARS-CoV-2.transcripts.ndb
├── References
│   └── SARS-CoV-2.ASM985889v3.dat
└── SupplementaryAnnotation
    └── SARS-CoV-2
        ├── SARS-COV-2_AllFreq.nsa
        ├── SARS-COV-2_AllFreq.nsa.idx
        ├── SARS-COV-2_AllFreq.nsa.schema
        ├── SARS-CoV-2_ProteinDomains.nsi
        └── SARS-CoV-2_ProteinDomains.nsi.schema

then the cache is ./Cache/SARS-CoV-2/ and thecache_prefix is SARS-CoV-2 (here the one that is the prefix of the filename), so it overall is resolved to ./Cache/SARS-CoV-2/SARS-CoV-2.

I am not certain we can enforce people to match the prefix on the actual files with the folder name. I have not seen more Nirvana caches to check how this normally looks like. Alternatively, we could possible stage in the files and somehow extract the cache prefix to build the path, but it feels brittle

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, we could possible stage in the files and somehow extract the cache prefix to build the path, but it feels brittle

I think we should do this at the workflow level, so I'm fine with this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants