Skip to content

Conversation

svarona
Copy link
Contributor

@svarona svarona commented Jun 11, 2024

Fixed issue #378:

  • Add taxonomic ID to BLAST output files
  • Detailed in the documentation filters used to generate .filter.blastn.txt
  • Added a header for raw .blastn.txt same as for filter.blastn.txt
  • Added parameters for BLAST filtering

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/viralrecon branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile 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).

Copy link

github-actions bot commented Jun 11, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit a4f6946

+| ✅ 190 tests passed       |+
#| ❔   2 tests were ignored |#
!| ❗   7 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • system_exit - System.exit in nanopore.nf: System.exit(1) [line 247]

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: assets/email_template.html
  • files_unchanged - File ignored due to lint config: assets/email_template.txt

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-06-17 09:55:20

@svarona svarona changed the title Blast Enhanced BLAST results filtering Jun 11, 2024
@svarona svarona requested a review from maxulysse June 13, 2024 12:02
Copy link

@Joon-Klaps Joon-Klaps left a comment

Choose a reason for hiding this comment

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

Some smaller suggestions.

CHANGELOG.md Outdated
@@ -36,6 +38,8 @@ Thank you to everyone else that has contributed by reporting bugs, enhancements
| | `--freyja_lineages` |
| | `--skip_freyja_boot` |
| | `--additional_annotation` |
| | `--min_contig_length` |
| | `--min_perc_cgaligned` |

Choose a reason for hiding this comment

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

I'm not certain this variable is very descriptive. What about --min_perc_contig_aligned or --blast_perc_aligned or something else?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I named it this way because the column is %cgAligned. But I can name it other way.

Choose a reason for hiding this comment

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

In my opinion, the %cgAligned will call for questions if you see this for the first time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

mmmm I think I'll go with --min_perc_contig_aligned and write a more exhaustive description of the BLAST headers in the documentation. The %cgAligned column has always been there, but I think it is not properly described. Thanks!

publishDir = [
path: { "${params.outdir}/assembly/spades/${params.spades_mode}/blastn" },
mode: params.publish_dir_mode,
saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
enabled: false

Choose a reason for hiding this comment

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

It might not always be interesting to not publish this? What about an additional variable that controls this --save_blast_unfiltered ?

If you agree make sure to keep ${meta.id}.filter.blastn

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfiltered blast is always saved, but it does it in the other process, here is only unfiltered blast with no header.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is generated inside modules/local/filter_blastn.nf

Choose a reason for hiding this comment

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

Aaah sorry! I missed those 2 new lines :D

Co-authored-by: Joon Klaps <61584065+Joon-Klaps@users.noreply.github.com>
@svarona svarona requested a review from Joon-Klaps June 17, 2024 15:23
Copy link

@Joon-Klaps Joon-Klaps left a comment

Choose a reason for hiding this comment

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

LGTM!

@svarona svarona merged commit ae67ea4 into nf-core:dev Jun 18, 2024
@svarona svarona deleted the blast branch June 18, 2024 07:13
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.

2 participants