Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new module: dysgu=v1.6.4 #5784

Closed
3 tasks
poddarharsh15 opened this issue Jun 10, 2024 · 9 comments · Fixed by #5928
Closed
3 tasks

new module: dysgu=v1.6.4 #5784

poddarharsh15 opened this issue Jun 10, 2024 · 9 comments · Fixed by #5928
Assignees
Labels
draft new module Adding a new module

Comments

@poddarharsh15
Copy link
Contributor

poddarharsh15 commented Jun 10, 2024

Hi, I am trying to learn how to add this new module "dysgu" for analysing structural variant in short or long reads in nf-core/sarek.

Tasks

@poddarharsh15 poddarharsh15 added the new module Adding a new module label Jun 10, 2024
@poddarharsh15 poddarharsh15 self-assigned this Jun 10, 2024
@poddarharsh15
Copy link
Contributor Author

@famosab famosab mentioned this issue Jun 21, 2024
17 tasks
@famosab
Copy link
Contributor

famosab commented Jun 21, 2024

We should probably divide this module into multiple submodules.

dysgu run              # Run using default arguments, wraps fetch and call commands
dysgu fetch            # Separate SV reads from input bam file
dysgu call             # SV calling
dysgu merge            # Merge calls from multiple samples
dysgu filter           # Filter SVs, find somatic SVs (version >= 1.5.0)
dysgu test             # Run basic tests

Each would be called dysgu/run, dysgu/fetch and so on

@poddarharsh15
Copy link
Contributor Author

For these modifications I need to add more inputs in main.nf file, meta.yml and update it? and for submodules is it necessary to add more .nf files to define the process?

@famosab
Copy link
Contributor

famosab commented Jun 21, 2024

You can check other modules which have submodules. It basically means one main.nf per subcommand. So one for dysgu run, one for dysgu call and so on. Those will be located within subfolders in the dysgu folder. Check out for example strelka or cnvkit.

@famosab
Copy link
Contributor

famosab commented Jun 21, 2024

We can first only add dysgu/run as module and the other ones can be done at some other time. We just need to restructure the folder in the PR.

@poddarharsh15
Copy link
Contributor Author

At the moment, adding the dysgu call module is more important because I need to run some analysis with the patient data I have, making it the first priority. While this data is processing, I can work on the remaining submodules. I will create a new folder for dysgu call, transfer all the necessary files there, and conduct another test run.
Apologies for the late response; I was leaving from work.
Thanks for clarifying all the doubts:))

@famosab
Copy link
Contributor

famosab commented Jun 24, 2024

I am a bit confused now: The module you were working on was clearly using the comman dysgu run - we usually name the submodules after the command if that is available. So dysgu/call needs to use dysgu call as command.

@poddarharsh15
Copy link
Contributor Author

Hi @famosab as the developer of dysgu explained

[ For paired-end data the run command is recommended which wraps fetch and call:]

dysgu run is used when we are working with paired-end reads and it works with both bam and cram files, while we are dealing with long-reads we used dysgu call It should work with dysgu run

@famosab
Copy link
Contributor

famosab commented Jun 24, 2024

Ok then we need two submodules, one called dysgu/run and dysgu/call or we make that dependent on the input that is given to the module. I am unsure what would be best practise here. Maybe you can ask in the slack. Or @maxulysse or @FriederikeHanssen can help as they are sarek developers.

@poddarharsh15 poddarharsh15 changed the title new module: dysgu=v1.6.2 new module: dysgu=v1.6.4 Jul 5, 2024
@famosab famosab mentioned this issue Jul 8, 2024
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
draft new module Adding a new module
Projects
No open projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants