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

Adding Kraken2 metagenomics classifier #355

Merged
merged 18 commits into from
Feb 21, 2020
Merged

Adding Kraken2 metagenomics classifier #355

merged 18 commits into from
Feb 21, 2020

Conversation

maxibor
Copy link
Member

@maxibor maxibor commented Feb 19, 2020

Adding Kraken2 metagenomics classifier

  • Add processes in main.nf
  • Add scripts to process Kraken outputs in bin
  • Add/Modify documentation for Kraken
  • Add tests for Kraken

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 necessary, also make a PR on the nf-core/eager branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md

@maxibor maxibor requested a review from jfy133 February 19, 2020 16:33
@maxibor maxibor added enhancement New feature or request 2.1.0 labels Feb 19, 2020
@maxibor maxibor added this to the V2.1 "Ulm" milestone Feb 19, 2020
@maxibor maxibor mentioned this pull request Feb 19, 2020
@maxibor maxibor linked an issue Feb 19, 2020 that may be closed by this pull request
README.md Outdated
@@ -67,6 +67,7 @@ Additional functionality contained by the pipeline currently includes:
#### Metagenomic Screening

* Taxonomic binner with alignment (`MALT`)
* Taxonomic binner without alignment (`Kraken2`)
* aDNA characteristic screening of taxonomically binned data (`MaltExtract`)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* aDNA characteristic screening of taxonomically binned data (`MaltExtract`)
* aDNA characteristic screening of taxonomically binned data from MALT (`MaltExtract`)

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed

'''
INPUT:
infile (str): path to kraken report file
countlim (int): lower count threshold to report hit
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
countlim (int): lower count threshold to report hit
countlim (int): lowest count threshold to report hit

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

'-o',
dest="output",
default=None,
help="Output file. Default = sources.csv")
Copy link
Member

Choose a reason for hiding this comment

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

What does 'sources' mean here? Or is this a leftover from CoproID? Maybe should be changed to same on line 58?

Copy link
Member Author

Choose a reason for hiding this comment

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

From kraken-nf actually ;)
Changed to use the name given by the CLI. (default="kraken_count_table.csv")

docs/usage.md Outdated
respectively. Ensure your database matches the mode. Check the [MALT manual](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf) for more details. Default: 'BlastN'
respectively. Ensure your database matches the mode. Check the [MALT manual](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf) for more details. Default: 'BlastN'

Only when `--metagenomic_tool malt`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Only when `--metagenomic_tool malt`
Only when `--metagenomic_tool malt` is also supplied

While I thought this would've been implicit with the paramtere name, better to be explicit ;). The complete sentence can be applied to all below as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed every occurence to your suggestion

nextflow.config Outdated
database = ''
percent_identity = 85
malt_mode = 'BlastN'
malt_alignment_mode = 'SemiGlobal'
malt_top_percent = 1
malt_min_support_mode = 'percent'
malt_min_support_percent = 0.01
malt_min_support_reads = 1
metagenomic_min_support_reads = 1
Copy link
Member

Choose a reason for hiding this comment

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

Duplicate here with line 168? Any reason why?

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

@maxibor maxibor requested a review from jfy133 February 20, 2020 13:58
@jfy133 jfy133 merged commit 103a746 into nf-core:dev Feb 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add metagenomics module
2 participants