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 Picrust2 #307

Merged
merged 3 commits into from
Jul 29, 2021
Merged

Add Picrust2 #307

merged 3 commits into from
Jul 29, 2021

Conversation

d4straub
Copy link
Collaborator

@d4straub d4straub commented Jul 28, 2021

This solves the old issue #41

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 - add to the software_versions process and a regex to scrape_software_versions.py
    • If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/ampliseq/tree/master/.github/CONTRIBUTING.md)
    • If necessary, also make a PR on the nf-core/ampliseq 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).
  • 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
Copy link

github-actions bot commented Jul 28, 2021

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 97d7248

+| ✅ 136 tests passed       |+
!| ❗   2 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • readme - README did not have a Nextflow minimum version mentioned in Quick Start section.

✅ Tests passed:

Run details

  • nf-core/tools version 2.1
  • Run at 2021-07-29 11:13:35

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.

Nice work, just some grammar suggestions.

CITATIONS.md Outdated
* [PICRUSt2](https://pubmed.ncbi.nlm.nih.gov/32483366/)
> Douglas GM, Maffei VJ, Zaneveld JR, Yurgel SN, Brown JR, Taylor CM, Huttenhower C, Langille MGI. PICRUSt2 for prediction of metagenome functions. Nat Biotechnol. 2020 Jun;38(6):685-688. doi: 10.1038/s41587-020-0548-6. PMID: 32483366; PMCID: PMC7365738.

* PICRUSt2 is using in this pipeline by default [EPA-ng](https://pubmed.ncbi.nlm.nih.gov/30165689/)
Copy link
Member

Choose a reason for hiding this comment

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

Grammar is not correct in "is using in", do you mean "is used in" or maybe "is using"? If the latter, maybe "pipeline" is not correct, maybe just "PICRUSt2 is by default using [EPA-ng]"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, will change!

CITATIONS.md Outdated
* PICRUSt2 is using in this pipeline by default [EPA-ng](https://pubmed.ncbi.nlm.nih.gov/30165689/)
> Barbera P, Kozlov AM, Czech L, Morel B, Darriba D, Flouri T, Stamatakis A. EPA-ng: Massively Parallel Evolutionary Placement of Genetic Sequences. Syst Biol. 2019 Mar 1;68(2):365-369. doi: 10.1093/sysbio/syy054. PMID: 30165689; PMCID: PMC6368480.

* PICRUSt2 is using in this pipeline by default [MinPath](https://pubmed.ncbi.nlm.nih.gov/19680427/)
Copy link
Member

Choose a reason for hiding this comment

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

Same as above.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, will change!

docs/output.md Outdated
@@ -27,6 +27,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
* [Alpha diversity indices](#alpha-diversity-indices) - Diversity within samples
* [Beta diversity indices](#beta-diversity-indices) - Diversity between samples (e.g. PCoA plots)
* [ANCOM](#ancom) - Differential abundance analysis
* [PICRUSt2](#picrust2) - Predicting functional abundances
Copy link
Member

Choose a reason for hiding this comment

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

Or "Predicting functional genes", "Predicting functional gene abundances"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I changed to "Predict the functional potential of a bacterial community"

@@ -103,6 +103,10 @@
"description": "Naming of sequencing files",
"help_text": "Indicates the naming of sequencing files (default: `\"/*_R{1,2}_001.fastq.gz\"`).\n\nPlease note:\n\n1. The prepended slash (`/`) is required\n2. The star (`*`) is the required wildcard for sample names\n3. The curly brackets (`{}`) enclose the orientation for paired end reads, seperated by a comma (`,`).\n4. The pattern must be enclosed in quotes\n\nFor example for one sample (name: `1`) with forward (file: `1_a.fastq.gz`) and reverse (file: `1_b.fastq.gz`) reads in folder `data`:\n\n```bash\n--input \"data\" --extension \"/*_{a,b}.fastq.gz\"\n```"
},
"picrust": {
"type": "boolean",
"description": "If functional abundances are predicted from the marker genes."
Copy link
Member

Choose a reason for hiding this comment

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

"Functional gene abundances predicted from phylogenetic relationships to marker gene organisms."?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed.

@@ -520,6 +521,18 @@ workflow AMPLISEQ {
}
}

//
// MODULE: Predict functional abundances from marker genes with Picrust2
Copy link
Member

Choose a reason for hiding this comment

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

"functional gene abundances"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed.

@d4straub
Copy link
Collaborator Author

The tests fail most likely because Picrust2 needs more than the 6GB RAM that is available for ci tests. It seems that the required RAM is independent of the ASV numbers but might be due to the databases that need to be loaded. I'll keep it in the test_full profile which is executed in AWS on demand/release, but not in test_doubleprimers.

@erikrikarddaniel
Copy link
Member

erikrikarddaniel commented Jul 29, 2021 via email

@d4straub d4straub merged commit 73d1e26 into nf-core:dev Jul 29, 2021
@d4straub d4straub deleted the add-picrust branch July 29, 2021 11:39
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