Skip to content

Conversation

chaochaowong
Copy link
Contributor

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 fulfill 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

@chaochaowong chaochaowong added the new module Adding a new module label Oct 2, 2025
@chaochaowong chaochaowong self-assigned this Oct 2, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason why the test data is not in the nf-core/test-data repository or you can't use existing test data? otherwise i think it looks good

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, @CaroAMN, for reviewing my module. I couldn’t use the existing PacBio test dataset because the coverage is too low, so I created a test set with ~2,000 reads covering chr22. I wasn’t aware that test data should be deposited in the nf-core/test-datasets repository—thanks for pointing that out. I’ll add it there this weekend, update the module to use it, and ping you for another look.

Once again, thank you.

Copy link
Contributor

Choose a reason for hiding this comment

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

In the nf-core documentation, there is a guide on how to add test data (similar to adding modules). It could be a problem if your test data is too big, then i would ask in Slack what people recommend. In general, i would reduce it as much as possible (see nf-core guidelines). :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants