Content of review 1, reviewed on January 03, 2021
Danecek et al. summarized the status, new features, and improvements in the SAMtools and BCFtools. They described the details in performance optimization, the new design of the separation of IO and CPU intensive tasks, and the separation of HTSlib from the tools. They also discussed the benefit of adopting software engineering techniques into SAMtools and BCFtools development. The paper is well written in clear language. The software is widely used and well documented.
I only have a few minor observations regarding the manuscript.
- It would be clearer to rephrase or explain the problem these tools addressed in the Abstract section. Although the tools themselves speak a lot, it would still be friendly to a broader audience.
- The transition of the first paragraph of the BCFtools section is not smooth. Consider moving the second sentence to the next paragraph.
- As the authors pointed out, there might be suboptimal usages among third-party tutorials or home-brewed pipelines. It would be helpful to provide flowcharts with "best practices" for typical scenarios.
Declaration of competing interests Please complete a declaration of competing interests, considering the following questions: Have you in the past five years received reimbursements, fees, funding, or salary from an organisation that may in any way gain or lose financially from the publication of this manuscript, either now or in the future? Do you hold any stocks or shares in an organisation that may in any way gain or lose financially from the publication of this manuscript, either now or in the future? Do you hold or are you currently applying for any patents relating to the content of the manuscript? Have you received reimbursements, fees, funding, or salary from an organization that holds or has applied for patents relating to the content of the manuscript? Do you have any other financial competing interests? Do you have any non-financial competing interests in relation to this paper? If you can answer no to all of the above, write 'I declare that I have no competing interests' below. If your reply is yes to any, please give details below.
I declare that I have no competing interests.
I agree to the open peer review policy of the journal. I understand that my name will be included on my report to the authors and, if the manuscript is accepted for publication, my named report including any attachments I upload will be posted on the website along with the authors' responses. I agree for my report to be made available under an Open Access Creative Commons CC-BY license (http://creativecommons.org/licenses/by/4.0/). I understand that any comments which I do not wish to be included in my named report can be included as confidential comments to the editors, which will not be published. I agree to the open peer review policy of the journal.
Authors response to reviews:
Reviewer #1: Danecek et al. summarized the status, new features, and improvements in the SAMtools and BCFtools. They described the details in performance optimization, the new design of the separation of IO and CPU intensive tasks, and the separation of HTSlib from the tools. They also discussed the benefit of adopting software engineering techniques into SAMtools and BCFtools development. The paper is well written in clear language. The software is widely used and well documented.
I only have a few minor observations regarding the manuscript. 1. It would be clearer to rephrase or explain the problem these tools addressed in the Abstract section. Although the tools themselves speak a lot, it would still be friendly to a broader audience.
Thank you for the suggestion. We updated the text to describe that the programs include tools for file format conversion and manipulation, sorting, querying, statistics, variant calling and effect analysis amongst other methods.
- The transition of the first paragraph of the BCFtools section is not smooth. Consider moving the second sentence to the next paragraph.
We have restructured according to your suggestion, thank you.
- As the authors pointed out, there might be suboptimal usages among third-party tutorials or home-brewed pipelines. It would be helpful to provide flowcharts with "best practices" for typical scenarios.
Thank you, that's a good point. We have added links to the workflows and documentation:
"We encourage readers to follow best practices and workflows published at https://www.htslib.org/workflow/"
and
"Full documentation for these commands is included with the package in the form of UNIX man pages, and can also be found online together with short tutorials, math notes, and other documentation at https://samtools.github.io/bcftools"
Reviewer #2: Just a few very minor nits to pick:
Background paragraph 3: "the release 0.1.4" -> "release 0.1.4"
Fixed, thank you.
Findings paragraph 2: A table with ~1 sentence summaries of what these commands currently do would be nice here. (Given that this is a "12 years" retrospective article, this table could also include the date or version number where each command was introduced.)
Thank you for the suggestion, it is a good idea. We added supplementary tables with SAMtools and BCFtools commands and plugins.
BCFtools paragraph 6: Can add a reference regarding how variant caller accuracy and speed compares to today's other most commonly used tools. Could do the same for the ROH caller.
Although the intention for this article is to describe recent updates rather than act as a comparison to other tools, we have added references to a few comparison articles. We'd be happy to include more references if we missed them in literature.
Discussion paragraph 3: "UndefinedBehaviourSanitizer" -> "UndefinedBehaviorSanitizer"
Fixed, thank you.
Discussion paragraph 4: First sentence should be rewritten to have correct grammar.
This sentence has now been revised. Thank you.
Discussion paragraph 5: "species, vertebrate, non-vertebrates," -> "species: vertebrates, non-vertebrates," "future developments" -> "future development"
Fixed, thank you.
Source
© 2021 the Reviewer (CC BY 4.0).
References
Petr, D., K., B. J., Jennifer, L., John, M., Valeriu, O., O., P. M., Andrew, W., Thomas, K., A., M. S., M., D. R., Heng, L. Twelve years of SAMtools and BCFtools. GigaScience.