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

Add sylph/profile module #7118

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

Conversation

sofstam
Copy link
Contributor

@sofstam sofstam commented Nov 28, 2024

PR checklist

Moves the local module sylph/profile to nf-core modules. Closes nf-core/seqinspector#65
Removes unnecessary pattern from sylph/sketch meta file.

  • 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

modules/nf-core/sylph/profile/meta.yml Outdated Show resolved Hide resolved
description: |
List of input FastQ/FASTA files of size 1 and 2 for single-end and paired-end data,
respectively. They are automatically sketched to .sylsp/.syldb
- - pre_sketched_files:
Copy link
Member

Choose a reason for hiding this comment

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

This says a Presketched db, but your test input supplies a fasta file.

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 documentation says:

Pre-sketched *.syldb/*.sylsp files. Raw single-end fastq/fasta are allowed and will be automatically sketched to .sylsp/.syldb.

That is why I supplied a fasta file. Updated the meta.yml file with this info too.

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.

Suggested to be a bit more specific about the created csv :)

"versions.yml:md5,7b5a545483277cc0ff9189f8891e737f"
],
[
false
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it expected that the contains check always leads to the string not being contained?

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 string should be contained. Looking into it.

modules/nf-core/sylph/profile/tests/main.nf.test Outdated Show resolved Hide resolved
{ assert process.success },
{ assert snapshot(
process.out.versions,
process.out.profile_out.collect { file(it[1]).readLines().contains("complete genome") },
Copy link
Contributor

Choose a reason for hiding this comment

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

MAybe you can assert the file a bit better using: https://github.com/lukfor/nft-csv

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you mean to count the columns of the output file?

Copy link
Contributor

Choose a reason for hiding this comment

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

anything that makes sense - counting columns or asserting column header both seems fine to me

modules/nf-core/sylph/sketch/meta.yml Show resolved Hide resolved
modules/nf-core/sylph/profile/main.nf Outdated Show resolved Hide resolved
modules/nf-core/sylph/profile/main.nf Outdated Show resolved Hide resolved
modules/nf-core/sylph/profile/main.nf Outdated Show resolved Hide resolved
@SPPearce
Copy link
Contributor

SPPearce commented Jan 8, 2025

@sofstam , do you need a hand to get this finished off?

@sofstam
Copy link
Contributor Author

sofstam commented Jan 8, 2025

@SPPearce Was on holidays, looking at the comments now :)

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.

5 participants