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

Added stub and nf-test for merquryfk/merquryfk #5632

Closed
wants to merge 2 commits into from

Conversation

GallVp
Copy link
Member

@GallVp GallVp commented May 18, 2024

PR checklist

Closes #XXX

  • Added stub and nf-test for merquryfk/merquryfk
  • 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

@GallVp GallVp requested review from mahesh-panchal and a team as code owners May 18, 2024 08:24
@GallVp GallVp requested review from CarsonJM and removed request for a team May 18, 2024 08:24
@GallVp
Copy link
Member Author

GallVp commented May 20, 2024

Hi @mahesh-panchal

FASTK is running out of memory. Any suggestions? Thank you!

@mahesh-panchal
Copy link
Member

I have no idea really. Best ask on nf-core.

I see also that some of the process selectors aren't matched, but I don't think that has anything to do with it.

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.

Had a few suggestions that might help to make the tests run?

Copy link
Contributor

Choose a reason for hiding this comment

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

If there is no conda package I would just remove the environment.yml file. You can suppress the conda tests in the by adding it here: https://github.com/nf-core/modules/blob/master/.github/workflows/test.yml

modules/nf-core/merquryfk/merquryfk/main.nf Show resolved Hide resolved

touch "${prefix}.qv"

echo \\
Copy link
Contributor

Choose a reason for hiding this comment

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

where is this echoed to? I think for the stub test it is enough to just create the expected output files via touch

Copy link
Member Author

Choose a reason for hiding this comment

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

This is echoed to standard output (.command.log) and can be helpful while debugging to know the original command that is executed without -stub.

script "../../../fastk/fastk"
process {
"""
input[0] = [
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 update the file paths according as shown here: https://github.com/nf-core/tools/pull/2985/files

[ id:'test', single_end:true ], []
]

input[0] = FASTK_FASTK.out.hist
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is enough to collect them all in a list given top input[0] but it is quite readable.

"""
assembly = [
[ id:'test', single_end:true ], // meta map
file(params.test_data['homo_sapiens']['genome']['genome_fasta'], 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.

update filepath

}
}

test("test_merquryfk_merquryfk_png") {
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 give a name that adheres more to the guidelines like (human - fasta)

}
}

test("multiple_minimal_stub") {
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure: Why do you need two different stub tests? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

One runs with haplotigs and the other without it.

@GallVp
Copy link
Member Author

GallVp commented May 22, 2024

Thank you @mahesh-panchal and @famosab for the feedback

MERQURY.FK is not a well maintained tool. Even if we find out and fix this FASTK segmentation issue, it does not work in trio mode. I have tested that elsewhere. As suggested by @mahesh-panchal slack post, I agree we should be using MERQURY itself. See PR: #5657

I would like to close this PR.

@famosab
Copy link
Contributor

famosab commented May 23, 2024

@GallVp I think you'll need to deprecate the module (https://nf-co.re/docs/contributing/modules#deprecating-a-module) then and create an issue for a new one. But that seems sensible to me.

@mahesh-panchal
Copy link
Member

I agree with deprecating this module too. It's kind of a shame, because the speed up and memory profile were much better, but really it would have been nicer if that was contributed directly back to the Merqury rather than a new unversioned unmaintained tool made. It was also nice that KATGC and SMUDGEPLOT were bundled here too.

@GallVp
Copy link
Member Author

GallVp commented May 23, 2024

Good idea. But deprecating the module requires going through the CI, which is failing?

@mahesh-panchal
Copy link
Member

True. Closing then seems the best. I'm still not sure what the issue is with the self hosted runners but they're not set up in the same way as Githubs.

@GallVp GallVp closed this May 23, 2024
@GallVp GallVp deleted the merquryfk branch May 28, 2024 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

3 participants