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

Issue 162 add assembler qc report #167

Merged

Conversation

tfalkarkea
Copy link
Collaborator

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • README.md is updated (including new tool citations and authors/contributors).

Comments

Added a module for transrate, which is a simple way to create some quality control metrics for an assembly file. The CSV transrate generates is then included in the final MultiQC, which has some minor formatting adjustments included in assets/multiqc_config.yml.

Further changes may be useful to this MultiQC formatting.

@github-actions
Copy link

github-actions bot commented Aug 24, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 6309064

+| ✅ 154 tests passed       |+
!| ❗   7 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 2.5.1
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in output.md: Write this documentation describing your workflow's output
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • system_exit - System.exit in NfcoreSchema.groovy: System.exit(1) [line 180]

✅ Tests passed:

Run details

  • nf-core/tools version 2.9
  • Run at 2023-08-25 20:02:33

Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

I think the module would be a good addition to the nf-core set of modules. A little more work, as you're required to provide tests, but usually worth it.

I have a question regarding whether the TRANSRATE module should unzip or not, see comment in the code. If the tool can be made to read gzipped files, that would be best, if not, let it take an unzipped file and feed it with the output from the UNPIGZ_CONTIGS module.

CITATIONS.md Show resolved Hide resolved
modules/local/transrate.nf Outdated Show resolved Hide resolved
workflows/metatdenovo.nf Outdated Show resolved Hide resolved
tfalkarkea and others added 2 commits August 24, 2023 10:39
Adopting input change to transrate.

Co-authored-by: Daniel Lundin <erik.rikard.daniel@gmail.com>
Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

Looks fine. Just a tiny comment.

modules/local/transrate.nf Outdated Show resolved Hide resolved
Copy link
Collaborator

@danilodileo danilodileo left a comment

Choose a reason for hiding this comment

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

LGTM

@erikrikarddaniel erikrikarddaniel merged commit 59538cf into nf-core:dev Aug 28, 2023
7 checks passed
@tfalkarkea tfalkarkea deleted the issue-162-add-assembler-qc-report branch August 29, 2023 13:21
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.

3 participants