Top considerations for creating bioinformatics software documentation
Open accessThe DOI matches its Crossref record; 3 of the 3 references it cites were found in a registry or an index.
Abstract
Investing in documenting your bioinformatics software well can increase its impact and save your time. To maximize the effectiveness of your documentation, we suggest following a few guidelines we propose here. We recommend providing multiple avenues for users to use your research software, including a navigable HTML interface with a quick start, useful help messages with detailed explanation and thorough examples for each feature of your software. By following these guidelines, you can assure that your hard work maximally benefits yourself and others.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
Analysis and design of RNA sequencing experiments for identifying isoform regulation
Katz, Y., Wang, E. T., Airoldi, E. M., & Burge, C. B. (2010) · Nature Methods · doi:10.1038/nmeth.1528 · Cited by 1,353
Ten Simple Rules for Reproducible Computational Research
Sandve, G. K., Nekrutenko, A., Taylor, J., & Hovig, E. (2013) · PLoS Computational Biology · doi:10.1371/journal.pcbi.1003285 · Cited by 880
Cost, benefits and quality of software development documentation: A systematic mapping
Zhi, J., Garousi-Yusifoğlu, V., Sun, B., Garousi, G., Shahnewaz, S., & Ruhe, G. (2015) · Journal of Systems and Software · doi:10.1016/j.jss.2014.09.042 · Cited by 112
Research works printed but not linked: 29
- Altschul, 1990, Basic local alignment search tool, J Mol Biol, 215, 403, 10.1016/S0022-2836(05)80360-2 · doi:10.1016/s0022-2836(05)80360-2 · Paper page
- Kumar, 2008, MEGA: a biologist-centric software for evolutionary analysis of DNA and protein sequences, Brief Bioinformatics, 9, 299, 10.1093/bib/bbn017 · DOI · Paper page
- Purcell, 2007, PLINK: a tool set for whole-genome association and population-based linkage analyses, Am J Hum Genet, 81, 559, 10.1086/519795 · DOI · Paper page
- Guex, 1997, SWISS-MODEL and the Swiss-PdbViewer: an environment for comparative protein modeling, Electrophoresis, 18, 2714, 10.1002/elps.1150181505 · DOI · Paper page
- Li, 2009, The sequence alignment/map format and SAMtools, Bioinformatics, 25, 2078, 10.1093/bioinformatics/btp352 · DOI · Paper page
- Li, 2009, Fast and accurate short read alignment with Burrows-Wheeler transform, Bioinformatics, 25, 1754, 10.1093/bioinformatics/btp324 · DOI · Paper page
- Rice, 2000, EMBOSS: the European molecular biology open software suite, Trends Genet, 16, 276, 10.1016/S0168-9525(00)02024-2 · DOI · Paper page
- Langmead, 2012, Fast gapped-read alignment with Bowtie 2, Nat Methods, 9, 357, 10.1038/nmeth.1923 · DOI · Paper page
- Anders, 2010, Differential expression analysis for sequence count data, Genome Biol, 11, R106., 10.1186/gb-2010-11-10-r106 · DOI · Paper page
- Trapnell, 2010, Transcript assembly and quantification by RNA-Seq reveals unannotated transcripts and isoform switching during cell differentiation, Nat Biotechnol, 28, 511, 10.1038/nbt.1621 · DOI · Paper page
- McKenna, 2010, The Genome Analysis Toolkit: a MapReduce framework for analyzing next-generation DNA sequencing data, Genome Res, 20, 1297, 10.1101/gr.107524.110 · DOI · Paper page
- Smyth, 2005, Bioinformatics and Computational Biology Solutions Using R and Bioconductor, 397, 10.1007/0-387-29362-0_23 · DOI · Paper page
- Robinson, 2010, edgeR: a Bioconductor package for differential expression analysis of digital gene expression data, Bioinformatics, 26, 139, 10.1093/bioinformatics/btp616 · DOI · Paper page
- Zhang, 2008, Model-based analysis of ChIP-Seq (MACS), Genome Biol, 9, R137, 10.1186/gb-2008-9-9-r137 · DOI · Paper page
- Quinlan, 2010, BEDTools: a flexible suite of utilities for comparing genomic features, Bioinformatics, 26, 841, 10.1093/bioinformatics/btq033 · DOI · Paper page
- Sievers F, Wilm, 2011, Fast, scalable generation of high-quality protein multiple sequence alignments using Clustal Omega, Mol Syst Biol, 7, 539, 10.1038/msb.2011.75 · DOI · Paper page
- Bailey, 2009, MEME Suite: tools for motif discovery and searching, Nucleic Acids Res, 37, W202, 10.1093/nar/gkp335 · DOI · Paper page
- Bolger, 2014, Trimmomatic: a flexible trimmer for Illumina sequence data, Bioinformatics, 30, 2114, 10.1093/bioinformatics/btu170 · DOI · Paper page
- Dobin, 2013, STAR: ultrafast universal RNA-seq aligner, Bioinformatics, 29, 15, 10.1093/bioinformatics/bts635 · DOI · Paper page
- Hoffman, 2012, Unsupervised pattern discovery in human chromatin structure through genomic segmentation, Nat Methods, 9, 473, 10.1038/nmeth.1937 · DOI · Paper page
- Huber, 2015, Orchestrating high-throughput genomic analysis with Bioconductor, Nat Methods, 12, 115, 10.1038/nmeth.3252 · DOI · Paper page
- Wickham, 2009, ggplot2: Elegant Graphics for Data Analysis, 10.1007/978-0-387-98141-3 · DOI · Paper page
- Piccolo, 2016, Tools and techniques for computational reproducibility, GigaScience, 5, 30., 10.1186/s13742-016-0135-4 · DOI · Paper page
- Hastings, 2014, Ten recommendations for software engineering in research, GigaScience, 3, 1, 10.1186/2047-217X-3-31 · DOI
- Artaza, 2016, Top 10 metrics for life science software good practices, F1000Res, 5, 2000, 10.12688/f1000research.9206.1 · DOI
- Seemann, 2013, Ten recommendations for creating usable bioinformatics command line software, GigaScience, 2, 1, 10.1186/2047-217X-2-15 · doi:10.1186/2047-217x-2-15
- Dzidek, 2008, A realistic empirical evaluation of the costs and benefits of UML in software maintenance, IEEE Trans Softw Eng, 34, 407, 10.1109/TSE.2008.15 · DOI · Paper page
- Booch, 2005, The Unified Modeling Language User Guide
- Dudley, 2009, A quick guide for developing effective bioinformatics programming skills, PLoS Comput Biol, 5, e1000589., 10.1371/journal.pcbi.1000589 · DOI
Cited by
A comparison of single-cell trajectory inference methods
Saelens, W., Cannoodt, R., Todorov, H., & Saeys, Y. (2019) · Nature Biotechnology · doi:10.1038/s41587-019-0071-9 · Cited by 1,670
Ten quick tips for machine learning in computational biology
Chicco, D. (2017) · BioData Mining · doi:10.1186/s13040-017-0155-3 · Cited by 878
Reproducibility standards for machine learning in the life sciences
Heil, B. J., Hoffman, M. M., Markowetz, F., Lee, S.-I., Greene, C. S., & Hicks, S. C. (2021) · Nature Methods · doi:10.1038/s41592-021-01256-7 · Cited by 255
Self-citationMaguire, F., Jia, B., Gray, K. L., Lau, W. Y. V., Beiko, R. G., & Brinkman, F. S. L. (2020) · Microbial Genomics · doi:10.1099/mgen.0.000436 · Cited by 152
“Additionally, it would provide a way to further optimize parameter settings of existing metagenomic assembly and binning tools beyond the default settings used in these analyses (considered representative of most ‘real-world’ usage [91]) without overfitting to a particular metagenome.”
Mangul, S., Mosqueiro, T., Abdill, R. J., Duong, D., Mitchell, K., Sarwal, V., Hill, B., Brito, J., Littman, R. J., Statz, B., et al. (2019) · PLOS Biology · doi:10.1371/journal.pbio.3000333 · Cited by 90
Metadata
- Authors
- Karimzadeh, M., & Hoffman, M. M.
- Venue
- Briefings in Bioinformatics
- Publisher
- Oxford University Press (OUP)
- Published
- 2017-01-14
- Volume
- 19
- Issue
- 4
- Pages
- 693-699
- ISSN
- 1467-5463 (ISSN-L)
- 1477-4054
- OpenAlex
- W2551432253
- Cited by
- 51
- References
- 3
- FWCI
- 5.48
- Type
- journal article
- Language
- en
- Open access
- hybrid
- Funders
- Canadian Cancer Society (703827)
- Ontario Institute for Cancer Research
- Natural Sciences and Engineering Research Council of Canada (RGPIN-2015-03948)
- Ministry of Research, Innovation and Science (ER-15-11-223)
- University of Toronto McLaughlin Centre (MC-2015-16)
- Princess Margaret Cancer Foundation (MC-2015-16)
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.