Skip to content

Add abi and custom adapters options to porechop_abi#591

Merged
jfy133 merged 33 commits into
crazy-corgifrom
porechop_abi
Apr 15, 2025
Merged

Add abi and custom adapters options to porechop_abi#591
jfy133 merged 33 commits into
crazy-corgifrom
porechop_abi

Conversation

@LilyAnderssonLee

Copy link
Copy Markdown
Contributor

Add params.longread_qc_predictadapters and params.longread_qc_adapterlist as ext.args for the module PORECHOP_ABI suggested by @AlexHoratio #589

PR checklist

  • 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 pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/taxprofiler branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@LilyAnderssonLee LilyAnderssonLee changed the title add params.longread_qc_predictadapters and params.longread_qc_adapter… Add abi and custom adapters options to porechop_abi Mar 25, 2025
@github-actions

github-actions Bot commented Mar 25, 2025

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 4b6fbb9

+| ✅ 281 tests passed       |+
!| ❗  18 tests had warnings |!
Details

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • local_component_structure - krona_cleanup.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - kraken2_standard_report.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - shortread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - standardisation_profiles.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_filtering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - profiling.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - visualization_krona.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_fastp.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - nonpareil.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_complexityfiltering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-04-15 06:18:16

Comment thread nextflow.config Outdated
Comment thread conf/modules.config Outdated
Comment thread docs/output.md Outdated
Comment thread docs/output.md Outdated
Comment thread nextflow.config Outdated
sofstam and others added 3 commits April 8, 2025 15:18
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Comment thread conf/modules.config Outdated
@sofstam

sofstam commented Apr 10, 2025

Copy link
Copy Markdown
Collaborator

@nf-core-bot fix linting

@sofstam

sofstam commented Apr 10, 2025

Copy link
Copy Markdown
Collaborator

@nf-core-bot fix linting

@sofstam

sofstam commented Apr 10, 2025

Copy link
Copy Markdown
Collaborator

@nf-core-bot fix linting

@sofstam sofstam requested a review from jfy133 April 10, 2025 13:50
Comment thread conf/modules.config Outdated
Comment thread docs/usage.md
Comment thread workflows/taxprofiler.nf Outdated
sofstam and others added 3 commits April 11, 2025 09:18
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
@sofstam

sofstam commented Apr 11, 2025

Copy link
Copy Markdown
Collaborator

@nf-core-bot fix linting

@sofstam sofstam requested a review from jfy133 April 11, 2025 09:28

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One correction to usage.md and slight improvement to parameter doc but otherwise LGTM

Comment thread docs/usage.md Outdated
Both tools support length filtering of reads and can be tuned with `--shortread_qc_minlength`. Performing length filtering can be useful to remove short (often low sequencing complexity) sequences that result in unspecific classification and therefore slow down runtime during classification/profiling, with minimal gain.

There are currently two options for long-read Oxford Nanopore processing: [`porechop`](https://github.com/rrwick/Porechop), [`porechop_abi`](https://github.com/bonsai-team/Porechop_ABI).
You can enable on the `abi` option by turning on `--longread_qc_predictadapters` to predict adapters directly from the reads.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this needs it own subsection/eader as it is tool specific guidance (the rest seems to be generic), and also --longread_qc_predictadpaters doesn't tell it to use porechop_abi does it?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

You are right, it does not explain that -longread_qc_predictadpaters uses porechop_abi. Making the docs more clear.

Comment thread docs/usage.md Outdated
Comment thread nextflow_schema.json Outdated
sofstam and others added 4 commits April 14, 2025 13:22
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
@sofstam

sofstam commented Apr 14, 2025

Copy link
Copy Markdown
Collaborator

@nf-core-bot fix linting

Comment thread docs/usage.md
You can also turn off clipping and only perform paired-end merging, if requested. This can be useful when processing data downloaded from the ENA, SRA, or DDBJ (`--shortread_qc_skipadaptertrim`).
Both tools support length filtering of reads and can be tuned with `--shortread_qc_minlength`. Performing length filtering can be useful to remove short (often low sequencing complexity) sequences that result in unspecific classification and therefore slow down runtime during classification/profiling, with minimal gain.

###### Long reads

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
###### Long reads
##### Long reads

Comment thread docs/usage.md
Comment thread nextflow_schema.json Outdated
@jfy133

jfy133 commented Apr 15, 2025

Copy link
Copy Markdown
Member

Thank @LilyAnderssonLee @sofstam !

@jfy133 jfy133 merged commit daf5543 into crazy-corgi Apr 15, 2025
@jfy133 jfy133 deleted the porechop_abi branch April 15, 2025 06:16
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.

4 participants