I see there is an `annotsv_annotsv` module but I’m...
# modules
a
I see there is an
annotsv_annotsv
module but I’m wondering if anyone has any examples of using it in a pipeline that they can share with me? It doesn’t appear to be used in any
nf-core
ones. @Nicolas Vannieuwkerke I note you are the maintainer so wondering if maybe you use it at CMGG?
n
It's being used in this pipeline: https://github.com/nf-cmgg/structural It's a mess though and I'm actively looking for better alternatives for this
a
Alternatives to the tool or to the way it's being used?
n
To the tool, it's not stable and is quite a pain to get working. Too bad the results are very good when it works
πŸ₯² 2
They've been planning to do a python rewrite for ages but I haven't seen any progress on that for some time...
m
Hi Nicolas, I got this error:
couldn't open "AnnotSV_annotations/Annotations_Human/Gene-based/NCBIgeneID/geneSymbol_NCBIgeneID.tsv": no such file or directory
while running
annotsv/annotsv
I used
annotsv/installannotations
and got:
AnnotSV_annotations/Annotations_Human/Gene-based
β”œβ”€β”€ ACMG
β”œβ”€β”€ ClinGen
β”œβ”€β”€ DDD
β”œβ”€β”€ ExAC
β”œβ”€β”€ GenCC
β”œβ”€β”€ gnomAD
β”œβ”€β”€ NCBIandHGNCgeneID
└── OMIM
The directory does not exist in the annotations folder. I am using the latest versions of both tools. Am I missing something here?
n
I have no idea, this tool can do some weird things. Can you make an issue on the annotsv repository?
Also, VEP is really improving on the SV annotations so we might be able to entirely drop this tool in the near future (hopefully)
m
Thanks, looking forward to that. I also posted an issue there. lets see.
πŸŽ‰ 1
I created an issue on the og annotsv repo (not the nf-core/annotsv repo). Is that what you were suggesting or I misunderstood you?
πŸ‘ 2
n
yes perfect, that's what I meant πŸ˜›
πŸ‘ 1
m
I was wondering because when I posted the issue there, I got a confused response. So I mentioned you in the thread πŸ˜…
n
thank I think you explained it pretty well in your last comment πŸ™‚ let me know if you need some help there
m
I think a version bump is needed. Can you check her response? Thanks a lot πŸ™‚
a
I'm unsure there, if you ran Install annotations from the same version that you use for the actual tool then there shouldn't be an issue
It would seem that you used a different version to install the annotations than you used for the actual tool call?
Ok actually I think the real issue is that her install annotations shell script is not versioned possibly
m
I re-verified that have used the latest available modules for both the tool and the annotations. Were you able to get it to work for yourself?
a
See my comment on the issue. I'm currently not at my desk but my personal feeling is that this is a flaw of the design of the install script and not actually the fault of the nf-core module (although the nf-core module is broken for any non-current version)
m
That makes sense. Thank you for the insight, let's see if she fixes it.
@Nicolas Vannieuwkerke she versioned the install script, could you please update the containers for the module?
n
This is not in a released version AFAIK so not much I can do now sorry
this 1
🫠 1
I'm also pretty swamped so it might be quicker if you give it a try yourself, I will of course help you if you want πŸ˜›
πŸ‘€ 1
a
I need to look at it a bit further, but this change is not hugely useful in nf-core unless we modify the module a bit more. We will also need to wait for an actual release so that it is available via BioConda
πŸ™ 1
m
I gave it a shot using a custom container with the tag argument added to the installation script, just like @Arthur suggested. Everything worked smoothly! The only tweak needed in the
annotsv/installannotations
module was adding the tag (@Arthur, is that what you meant by modifying it a bit more or something else?) Looking forward to this change being rolled out in the release and officially integrated into the module. Thanks a lot, you guys gratitude grazie
@Nicolas Vannieuwkerke > Done, v5.3.3 is posted (@lgmgeo)
n
I just merged in the bioconda recipe update πŸ™‚ You'll have to regenerate the containers and update the module for the changes to take effect
m
PR is ready for approval πŸ™‚
n
Thanks! Can you post the link here?
I am bit new to this, tried my best. lmk if there are any issues
n
It looks good πŸ˜› Nice job!
I also sent you an invite to nf-core, that way you don't have to wait for someone else to trigger your automated tests
m
Thanks, but some of the tests seemed to have failed
n
Looks like the snapshots aren't stable, how did you update them?
m
I did it with this:
nf-test test main.nf.test --update-snapshot
from the tests dir
n
Can you try running it with the
--profile +docker
option?
πŸ‘€ 1
m
Okay, both were successful
πŸŽ‰ 1
Sorry, but can you check again 😒 this time I ran it with
--profile +docker
n
Strange... I'll take a look
I left some comments πŸ˜›
πŸ‘€ 1
m
If I run with
--profile docker
, then it get:
Unknown configuration profile: 'docker'
n
Are you running nf-test in the root of the modules repository?
m
I tried from both, without the
--profile docker
, it runs successfully.
Copy code
Test Process ANNOTSV_ANNOTSV

  Test [bea9eb64] 'homo_sapiens - sv_vcf, sv_tbi, snv_vcf, annotations - stub' PASSED (11.918s)
  Snapshots:
    1 created [homo_sapiens - sv_vcf, sv_tbi, snv_vcf, annotations - stub]


Snapshot Summary:
  1 created

SUCCESS: Executed 1 tests in 12.497s
n
You need to run it with
--profile +docker
otherwise the test results won't be reproducible on other systems. Can you double check that you are running nf-test in the same directory as the nf-test.config file? https://github.com/nf-core/modules/blob/master/nf-test.config
πŸ‘€ 1
m
And you said that I should add
config ./nextflow.config
to the
main.nf.test
?
n
yes, that way the module will create VCF files
m
passed with
--profile +singularity
hope this also works?
n
yeah that's also fine πŸ˜›
m
Oof, I thought it would go through this time..
Thanks for bearing with this, but can you check again lol
n
on it πŸ˜‰
Seems like the versions file is not stable, can you double check the contents?
πŸ‘€ 1
m
Looks like I managed 😭😭
Merging?
n
yes it looks good! you can merge it πŸ˜‰
congrats on your first module update!
πŸ˜› 1
m
Thanks a lot for your help, Nicolas! gratitude danke
n
shared a GIF
πŸ˜› 1
m
Uggh, I made a mistake in the
installannotations
module,
TAG=\$(AnnotSV --version 2>/dev/null | sed 's/AnnotSV //' || echo "master")
INSTALL_annotations.sh \$TAG
The tag need to be `v3.5.3`not just
3.5.3
AnnotSV --version
returns just `3.5.3`leads to
fatal: Remote branch 3.5.3 not found in upstream origin
Need to update this. Will send a PR
n
no worries, let me know when you need a review πŸ˜›
πŸ‘Œ 1
a
Just as an aside:
Copy code
containerOptions "${ workflow.containerEngine == 'singularity' ? '--writable-tmpfs' : ''}"
When was this added? I made a comment on the repo that this is a fix to an issue with the install annotations step, but I don’t really think it should be hardcoded into the module because it introduces unexpected non-standard behaviour of singularity
n
I think I added that earlier because singularity runs had some read-write permission issues
a
Yeah, that is the fix (for now) but I'm just not sure how good it is to hardcode container options vs let users set and possibly append to them themselves πŸ€”
n
yeah it's just a default to get the module working out of the box, users can still overwrite this if they want
m
So, would you like me to remove it along with this other change I am making? or let that be?
@Nicolas Vannieuwkerke PR ready!
n
nice can you post the link?
n
looks good
gratitude grazie 1
a
This tool will be the death of me. Conda package is broken due to changes to the makefile and permissions on files.
🫠 1
n
I know the feeling πŸ˜