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: SKA/DISTANCE #7437

Open
wants to merge 41 commits into
base: master
Choose a base branch
from
Open

New module: SKA/DISTANCE #7437

wants to merge 41 commits into from

Conversation

itrujnara
Copy link
Contributor

@itrujnara itrujnara commented Feb 5, 2025

PR checklist

Add SKA/DISTANCE module
There is no non-stub test for the list input because SKA cannot handle URLs in the list

  • 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

itrujnara and others added 26 commits November 20, 2024 17:24
Co-authored-by: Jose Espinosa-Carrasco <[email protected]>
Co-authored-by: Jose Espinosa-Carrasco <[email protected]>
Co-authored-by: Jose Espinosa-Carrasco <[email protected]>
Co-authored-by: Jose Espinosa-Carrasco <[email protected]>
Copy link
Contributor

@famosab famosab left a comment

Choose a reason for hiding this comment

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

What exactly is the difference between the test with and without list? Would the list contain the URLs then? We could probably chain a setup with wget / curl to get local files?

modules/nf-core/ska/distance/main.nf Show resolved Hide resolved
"""
touch ${prefix}.distances.tsv
touch ${prefix}.clusters.tsv
touch ${prefix}.cluster.1.txt
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you adjust this stub test to produce a different number of cluster.*.txt files based on the args or the input?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The number of clusters is not determinable from the size of the input, but I can assume every input file is a separate cluster

Comment on lines 42 to 49
stub:
def args = task.ext.args ?: ''
def prefix = task.ext.prefix ?: "${meta.id}"
"""
touch ${prefix}.distances.tsv
touch ${prefix}.clusters.tsv
touch ${prefix}.cluster.1.txt
touch ${prefix}.dot
Copy link
Contributor

Choose a reason for hiding this comment

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

More general: Can the stub be modified so that only the files are produced that are to be expected upon a specific input (because you marked the outputs as optional)?

modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
modules/nf-core/ska/distance/meta.yml Outdated Show resolved Hide resolved
@itrujnara itrujnara requested a review from famosab February 6, 2025 15:04
@itrujnara
Copy link
Contributor Author

Implementing the list test took way too long, but it works now. I hope I haven't added too many evil lines.

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.

3 participants