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

Lighter #6626

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

Lighter #6626

wants to merge 4 commits into from

Conversation

vtorda
Copy link

@vtorda vtorda commented Sep 11, 2024

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

@vtorda vtorda requested a review from a team as a code owner September 11, 2024 10:38
@vtorda vtorda requested review from koenbossers and removed request for a team September 11, 2024 10:38
Copy link
Contributor

@nvnieuwk nvnieuwk left a comment

Choose a reason for hiding this comment

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

Some comments, but overall good job on this one 🥳

Comment on lines +13 to +16
val genome_size //Estimated or user specified genome size
val kmer_size //K_mer size
val alpha // define alpha is optional, because "When using "-K" instead of "-k", Lighter will go through the reads an extra pass to decide C. "
val output_dir
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these required values for the module to run?

Comment on lines +19 to +20
tuple val(meta), path("*.fq.gz"), emit: outfastq
path "versions.yml" , emit: versions
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
tuple val(meta), path("*.fq.gz"), emit: outfastq
path "versions.yml" , emit: versions
tuple val(meta), path("*.fq.gz"), emit: outfastq
path "versions.yml" , emit: versions

-r ${readList.join(' -r ')} \\
$k_par \\
-t $task.cpus \\
-od ${output_dir} \\
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
-od ${output_dir} \\
-od ${prefix} \\

I think it makes more sense to use the prefix here

---
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/meta-schema.json
name: "lighter"
## TODO nf-core: Add a description of the module and list keywords
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
## TODO nf-core: Add a description of the module and list keywords

doi: "10.1186/s13059-014-0509-9"
licence: ["MIT"]

## TODO nf-core: Add a description of all of the variables used as input
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
## TODO nf-core: Add a description of all of the variables used as input

when {
process {
"""
// TODO nf-core: define inputs of the process here. Example:
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
// TODO nf-core: define inputs of the process here. Example:

Comment on lines +44 to +45
//TODO nf-core: Add all required assertions to verify the test output.
// See https://nf-co.re/docs/contributing/tutorials/nf-test_assertions for more information and examples.
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
//TODO nf-core: Add all required assertions to verify the test output.
// See https://nf-co.re/docs/contributing/tutorials/nf-test_assertions for more information and examples.


}

// TODO nf-core: Change the test name preferably indicating the test-data and file-format used but keep the " - stub" suffix.
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
// TODO nf-core: Change the test name preferably indicating the test-data and file-format used but keep the " - stub" suffix.

when {
process {
"""
// TODO nf-core: define inputs of the process here. Example:
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
// TODO nf-core: define inputs of the process here. Example:

assertAll(
{ assert process.success },
{ assert snapshot(process.out).match() }
//TODO nf-core: Add all required assertions to verify the test output.
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
//TODO nf-core: Add all required assertions to verify the test output.

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