Skip to content

Adjusted handling of MetaBAT2 output files#59

Merged
skrakau merged 1 commit intonf-core:devfrom
skrakau:adjust_for_empty_files
Jul 1, 2020
Merged

Adjusted handling of MetaBAT2 output files#59
skrakau merged 1 commit intonf-core:devfrom
skrakau:adjust_for_empty_files

Conversation

@skrakau
Copy link
Copy Markdown
Member

@skrakau skrakau commented Jun 30, 2020

I introduced a bug by updating Metabat2 to v2.15 in PR #56: this version of MetaBAT2 outputs additional files "*.lowDepth.fa" and "*.tooShort.fa", which might be empty and cause problems when passed forward to the process quast_bins.

To fix this, and since those files should anyway not be processed further, I moved all the unbinned FASTA files that are smaller than --min_length_unbinned_contigs (i.e. *.tooShort.fa, *.lowDepth.fa, *.unbinned.pooled.fa, *.unbinned.remaining.fa) to a folder discarded. However, those files will still be published. Additionally I renamed the file "*.unbinned.fa.remaining" to "*.unbinned.remaining.fa" for the sake of consistency.

@d4straub do you think that's OK in this way and the naming of the files ending up in the results folder should stay like this? If yes, some information about this could be added to the output.md

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/mag 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/mag/tree/master/.github/CONTRIBUTING.md

@skrakau skrakau requested a review from d4straub June 30, 2020 13:13
@d4straub
Copy link
Copy Markdown
Collaborator

Yes, I think this looks good. I am not sure if anybody needs so many files in the "discarded" folder. The alternative would be to merge these. However, it also doesn't hurt to have an explanation why the contigs do not end up in the final MAGs, i.e. the docs need a definition what contigs end up in what file.

@skrakau skrakau force-pushed the adjust_for_empty_files branch from 44864e7 to 438d21e Compare June 30, 2020 14:31
@skrakau
Copy link
Copy Markdown
Member Author

skrakau commented Jun 30, 2020

unused FASTA files are now also in the final results located within a discarded subfolder.

Still needs to be documented.

@skrakau skrakau force-pushed the adjust_for_empty_files branch from 438d21e to 5b1ebb8 Compare June 30, 2020 14:36
Copy link
Copy Markdown
Collaborator

@d4straub d4straub left a comment

Choose a reason for hiding this comment

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

Alright, but documentation is required at some point.

@skrakau skrakau merged commit 60cd556 into nf-core:dev Jul 1, 2020
@skrakau skrakau deleted the adjust_for_empty_files branch November 4, 2020 10:30
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