Skip to content

Yleaf module added @3.3.0 #8210

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Conversation

trianglegrrl
Copy link

@trianglegrrl trianglegrrl commented Apr 4, 2025

This adds the Yleaf package (https://doi.org/10.1093/molbev/msy032) at
3.3.0. Currently locked to the local version while necessary Yleaf
update is pending (genid/Yleaf#32)

Closes #8211.

PR checklist

Closes #XXX

  • 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

This adds the Yleaf package (https://doi.org/10.1093/molbev/msy032) at
3.3.0. Currently locked to the local version while necessary Yleaf
update is pending.
@trianglegrrl trianglegrrl marked this pull request as draft April 4, 2025 09:40
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Looking good, some initial comments until bioconda recipe is ready

def args = task.ext.args ?: ''
def prefix = task.ext.prefix ?: "${meta.id}"
def ref_genome = reference_genome ?: "hg38"
// These defaults correspond to the defaults used in the Yleaf package
Copy link
Member

Choose a reason for hiding this comment

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

Small comment: if the tool itself has it's own defaults then you don't need to define all of these. Input vals should ONLY be for mandatory inputs where there is no default 1

Footnotes

  1. https://nf-co.re/docs/guidelines/components/modules#non-file-mandatory-command-arguments

Comment on lines +45 to +48
{ assert process.out.versions != null },
{ assert process.out.haplogroup != null },
{ assert process.out.tree != null },
{ assert process.out.log != null }
Copy link
Member

Choose a reason for hiding this comment

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

Is this checking that teh file exists because they are variable? If so we have other patterns for this: https://nf-co.re/docs/contributing/nf-test/assertions

Copy link
Member

Choose a reason for hiding this comment

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

In fact you don't need the != bit at all

then {
assertAll(
{ assert process.success },
{ assert process.out.versions != null },
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
{ assert process.out.versions != null },
{ assert process.out.versions },

Also all of these can go into a snapshot() function, so they are more explicitly recorded - see other modules for examples

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.

new module: Yleaf
3 participants