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

Hifiadapterfilt #7398

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

Hifiadapterfilt #7398

wants to merge 4 commits into from

Conversation

Ge94
Copy link

@Ge94 Ge94 commented Jan 30, 2025

This PR was created to introduce hifiadapterfilt as a new module. It's purpose is to remove adapters that are specific to pacbio hifi reads.

PR checklist

Closes #7390

  • 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

@Ge94 Ge94 marked this pull request as ready for review January 30, 2025 16:12
@vagkaratzas vagkaratzas self-requested a review February 3, 2025 14:14
Copy link
Contributor

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

Looks good! Just some minor comments; I understand that at the moment there is only one pacbio test dataset, that unfortunately doesn't have any adapters to filter. Would it be easy/possible to upload another pacbio minimal test dataset where adapters are getting filtered out (and probably also have fewer to non empty output files)? Also, even though the conda environment and the containers describe version 3.0.0, in the versions.yml, 3.0.1 is written out. Can you investigate why the mismatch?

modules/nf-core/hifiadapterfilt/main.nf Outdated Show resolved Hide resolved
modules/nf-core/hifiadapterfilt/main.nf Outdated Show resolved Hide resolved
Ge94 and others added 2 commits February 4, 2025 11:21
Co-authored-by: Evangelos Karatzas <[email protected]>
Co-authored-by: Evangelos Karatzas <[email protected]>
Comment on lines +4 to +6
[

]
Copy link
Contributor

Choose a reason for hiding this comment

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

The test produces no snaps at all - maybe this can be changed?

Comment on lines +25 to +29
{ assert snapshot(process.out[0][1].findAll {
file(it).name == "test.filt.fastq.gz" &&
file(it).name == "test.contaminant.blastout" &&
file(it).name == "test.blocklist" }).match()},
{ assert path(process.out.stats[0].get(1)).text.contains('Number of adapter contaminated ccs reads: 0 (0% of total)') },
Copy link
Contributor

Choose a reason for hiding this comment

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

These files seem to not be found in the snapshot?

"""
input[0] = [
[ id:'test' ],
file(params.test_data['homo_sapiens']['pacbio']['hifi'], 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.

can you change this to the newer path description? :)

file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/vcf/test.vcf.gz', checkIfExists: true)

when:
task.ext.when == null || task.ext.when

script:
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
script:
script:

def args = task.ext.args ?: ''
def prefix = task.ext.prefix ?: "${meta.id}"
// The tool AUTOMATICALLY detects fastq files from the input folder, hence an explicit call of "fastq" is not needed.

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

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: hifiadapterfilt
3 participants