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

Add Cellsnp to modules #5518

Merged
merged 22 commits into from
May 8, 2024
Merged

Add Cellsnp to modules #5518

merged 22 commits into from
May 8, 2024

Conversation

wxicu
Copy link
Contributor

@wxicu wxicu commented Apr 23, 2024

PR checklist

Related to #5072
Add cellsnp-lite.

  • 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.
  • Emit the versions.yml file.
  • 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

@wxicu wxicu requested a review from a team as a code owner April 23, 2024 21:39
@wxicu wxicu requested review from koenbossers and removed request for a team April 23, 2024 21:39
@tstoeriko tstoeriko self-requested a review April 26, 2024 08:27
Copy link
Contributor

@tstoeriko tstoeriko left a comment

Choose a reason for hiding this comment

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

Good job so far! I've made some suggestions, but I'm still new to nf-core, so it's probably a good idea to have someone else look at the module, too.

modules/nf-core/cellsnp/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/tests/main.nf.test Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/tests/main.nf.test Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/tests/main.nf.test Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/main.nf Outdated Show resolved Hide resolved
@wxicu
Copy link
Contributor Author

wxicu commented May 5, 2024

@tstoeriko thanks for your detailed suggestion! I have now splitted cellsnp into two submodules for mode a and b (also according to the documentation[https://cellsnp-lite.readthedocs.io/en/latest/main/manual.html]) to control the input type. Both Mode 1a and mode 2a requie only a single bam file. hope this will make the structure more clear.
I have also tried to make the output files included in the snapshot as many as possible

@wxicu wxicu requested a review from tstoeriko May 5, 2024 17:14
Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

This looks very nice.
I have a question though, the docs talk about 4 modes, calling them Mode1a, Mode1b, Mode2a, Mode2b. Which is this? Should it be e.g. mode1a rather than modea?

modules/nf-core/cellsnp/modea/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/modea/main.nf Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/modea/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/cellsnp/modea/tests/main.nf.test Outdated Show resolved Hide resolved
@SPPearce
Copy link
Contributor

SPPearce commented May 8, 2024

This looks very nice. I have a question though, the docs talk about 4 modes, calling them Mode1a, Mode1b, Mode2a, Mode2b. Which is this? Should it be e.g. mode1a rather than modea?

Oh, I see that you have indeed answered this in the comment above, so this is appropriate for either mode1a or mode2a.
Just a few minor things then it is ready to go.

input[0] = [[ id: 'sample1'],
file(params.modules_testdata_base_path + '/genomics/homo_sapiens/demultiplexing/chr21.bam', checkIfExists: true),
SAMTOOLS_INDEX.out.bai.map{it[1]},
file(params.modules_testdata_base_path + /genomics/homo_sapiens/demultiplexing/donor_genotype_chr21.vcf', checkIfExists: true),
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
file(params.modules_testdata_base_path + /genomics/homo_sapiens/demultiplexing/donor_genotype_chr21.vcf', checkIfExists: true),
file(params.modules_testdata_base_path + '/genomics/homo_sapiens/demultiplexing/donor_genotype_chr21.vcf', checkIfExists: true),

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thank you for pointing out. I have just found the error LOL

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@SPPearce I tried your suggestion but didnt pass the tests due to the error Not a valid path value type: groovyx.gpars.dataflow.DataflowVariable (DataflowVariable(value=null)) . It seems like I was trying to add a channel to the input channel. So i go back to the previous version now

wxicu and others added 2 commits May 8, 2024 22:03
@wxicu wxicu requested a review from SPPearce May 8, 2024 20:06
@wxicu wxicu added this pull request to the merge queue May 8, 2024
Merged via the queue into nf-core:master with commit e151c39 May 8, 2024
12 checks passed
@wxicu wxicu deleted the cellsnp branch May 8, 2024 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants