Hi everyone! Im building a module for <Yleaf>, a h...
# modules
a
Hi everyone! Im building a module for Yleaf, a human Y-DNA haplogroup caller. I'm hoping to get some guidance on how to set up my local environment to run my
nf-test
module tests using a LOCAL version of the Yleaf package that I have, and not the current Bioconda version. Is there a written guideline somewhere on how to use a local package for nf-test-ing a module, vs the released bioconda version? I haven't had much luck searching around. Details, and what I have already tried, written below. Thanks in advance! ------------------- Background: I've gotten a Bioconda recipe for Yleaf built and accepted. It's currently at version 3.2.1. Yleaf is great, but it's not set up to work well in pipelines. I have submitted a pull request to the Yleaf repo which adds the one feature I need (allowing you to specify the location of your reference genome on the command line, vs. downloading it or reading from that download cache) and bumps the version to 3.3.0. The maintainers of Yleaf are going to review my PR. When it's accepted and released, that will allow me to bump the bioconda recipe to 3.3.0 (because 3.3.0 contains my pipeline-agreeable changes) , and then everything will be just fine in the regular nf-core Yleaf module development/use workflow. In the meantime, while we are waiting for the Yleaf PR and then the subsequent Bioconda recipe PR to be merged, I would like to continue development on the module. I have a local version of Yleaf installed at
~/Yleaf
. I have my branch checked out on the Yleaf repo. I have done a
conda activate nf-core
, which is my environment for doing basic nf-core development. While in that environment, I have done a
cd ~/Yleaf && pip install -e .
If I then run Yleaf from the command line
Yleaf -h
, it shows me at version 3.3.0, which is my local version. I can run Yleaf manually with the new command-line flags added in my branch, and everything works great. However, when i try to run
nf-core modules test yleaf --profile conda
, it always uses the 3.2.1 version from bioconda, and NOT my local 3.3.0 version that runs as
Yleaf
in my current conda
nf-core
environment. After lots of searching around, I've seen mentions of using an
environment.yml
and using my locally-installed 3.3.0 Yleaf package, but I can't seem to make that work. It still and uses the 3.2.1 version, meaning that every one of my test runs takes about ten minutes, because it downloads the reference genome each time.
s
In your module folder there will be an
environment.yml
file. Does this have 3.2.1 in it? Can you make a (draft) PR showing your current setup?
a
@Simon Murray thanks for the message! The environment.yml has 3.3.0 in it, but I think the problem was unrelated to nf-test and actually related to something I must have done with conda. I created a new environment, installed my Yleaf@3.3.0 there, and it worked like a charm!
❤️ 1