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 comBGC #188

Merged
merged 32 commits into from
Jan 25, 2023
Merged

Add comBGC #188

merged 32 commits into from
Jan 25, 2023

Conversation

jasmezz
Copy link
Collaborator

@jasmezz jasmezz commented Jan 19, 2023

Closes #64

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/funcscan 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).

@github-actions

This comment was marked as resolved.

@github-actions
Copy link

github-actions bot commented Jan 19, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 2d96689

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

❗ Test warnings:

  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in README.md: Add full-sized test dataset and amend the paragraph below if applicable
  • pipeline_todos - TODO string in README.md: Mention aggregation tools: hAMRonization/comBGC,AMPcombi
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in WorkflowMain.groovy: Add Zenodo DOI for pipeline after first release
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline

✅ Tests passed:

Run details

  • nf-core/tools version 2.7.2
  • Run at 2023-01-24 16:01:08

@jasmezz jasmezz requested a review from a team January 19, 2023 15:16
Copy link
Contributor

@louperelo louperelo left a comment

Choose a reason for hiding this comment

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

Congratulations! Release is getting close now.

COMBGC ( ch_bgcresults_for_combgc )

ch_combgc_summaries = COMBGC.out.tsv
.collectFile(name: 'combgc_complete_summary.csv', storeDir: "${params.outdir}/reports/combgc", keepHeader:true)
Copy link
Contributor

Choose a reason for hiding this comment

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

To have it right in the output.md: will you have a summary for each sample plus the complete_summary in the output folder?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Exactly. Each sample gets an output in:
reports/combgc/sampleX/combgc_summary.tsv, and there is the concatenated version in:
reports/combgc/combgc_complete_summary.tsv

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Missing documentation!

@jasmezz
Copy link
Collaborator Author

jasmezz commented Jan 24, 2023

What documentation is missing? comBGC is mentioned in output.md. Since there are no parameters to adjust by the user, I did not list it there. Also not in usage.md... We could add a section with all 3 summary tools, but maybe mentioning in output docs is enough?

@jasmezz jasmezz requested a review from jfy133 January 24, 2023 16:01
@jfy133
Copy link
Member

jfy133 commented Jan 25, 2023

Ah fair point re docs, I'm surprised it was doucmented before it was in 😆 , see my questions on slack - will review this now again

@jfy133 jfy133 merged commit 66c13f6 into dev Jan 25, 2023
@jfy133 jfy133 deleted the comBGC branch January 25, 2023 10: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.

BGC Summary Table
4 participants