Ten simple rules for writing a paper about scientific software

Papers describing software are an important part of computational fields of scientific research. These “software papers” are unique in a number of ways, and they require special consideration to improve their impact on the scientific community and their efficacy at conveying important information. Here, we discuss 10 specific rules for writing software papers, covering some of the different scenarios and publication types that might be encountered, and important questions from which all computational researchers would benefit by asking along the way.

[1]  Geir Kjetil Hanssen,et al.  Automated Acceptance Testing: A Literature Review and an Industrial Case Study , 2008, Agile 2008 Conference.

[2]  Randal S. Olson,et al.  TPOT: A Tree-based Pipeline Optimization Tool for Automating Machine Learning , 2016, AutoML@ICML.

[3]  Trang T. Le,et al.  Scaling tree-based automated machine learning to biomedical big data with a feature set selector , 2019, Bioinform..

[4]  Hyoungjoo Park,et al.  Research software citation in the Data Citation Index: Current practices and implications for research software sharing and reuse , 2019, J. Informetrics.

[5]  Kai Blin,et al.  Ten Simple Rules for Taking Advantage of Git and GitHub , 2014, bioRxiv.

[6]  Paul A Clemons,et al.  The Connectivity Map: Using Gene-Expression Signatures to Connect Small Molecules, Genes, and Disease , 2006, Science.

[7]  Andreas Prlic,et al.  Ten Simple Rules for the Open Development of Scientific Software , 2012, PLoS Comput. Biol..

[8]  Brent Thoma,et al.  The Altmetric Score: A New Measure for Article-Level Dissemination and Impact. , 2015, Annals of emergency medicine.

[9]  Paul Humphreys,et al.  Extending Ourselves: Computational Science, Empiricism, and Scientific Method , 2004 .

[10]  Casey S. Greene,et al.  Recommendations to enhance rigor and reproducibility in biomedical research , 2020, GigaScience.

[11]  M. Daly,et al.  PGC-1α-responsive genes involved in oxidative phosphorylation are coordinately downregulated in human diabetes , 2003, Nature Genetics.

[12]  Jeffrey Chang,et al.  Biopython: Python tools for computational biology , 2000, SIGB.

[13]  David W. Brooks,et al.  “Link rot” limits the usefulness of web‐based educational materials in biochemistry and molecular biology * , 2003 .

[14]  Mariano J. Alvarez,et al.  Network-based inference of protein activity helps functionalize the genetic landscape of cancer , 2016, Nature Genetics.

[15]  Steven J. M. Jones,et al.  Circos: an information aesthetic for comparative genomics. , 2009, Genome research.

[16]  Stephan Druskat,et al.  Software and Dependencies in Research Citation Graphs , 2019, Computing in Science & Engineering.

[17]  Benjamin D Lee,et al.  Ten simple rules for documenting scientific software , 2018, PLoS Comput. Biol..

[18]  Gonçalo R. Abecasis,et al.  The Sequence Alignment/Map format and SAMtools , 2009, Bioinform..

[19]  Darko Marinov,et al.  Usage, costs, and benefits of continuous integration in open-source projects , 2016, 2016 31st IEEE/ACM International Conference on Automated Software Engineering (ASE).

[20]  Erik Wilde,et al.  Academic Search Engine Optimization (ASEO) , 2010 .

[21]  Jason H. Moore,et al.  TPOT-NN: augmenting tree-based automated machine learning with neural network estimators , 2020, Genetic Programming and Evolvable Machines.

[22]  Gaël Varoquaux,et al.  Scikit-learn: Machine Learning in Python , 2011, J. Mach. Learn. Res..

[23]  Peter Ebert,et al.  Ten Simple Rules for Developing Usable Software in Computational Biology , 2017, PLoS Comput. Biol..

[24]  Morgan Taschuk,et al.  Ten simple rules for making research software more robust , 2016, PLoS Comput. Biol..

[25]  Piotr Sliz,et al.  A Quick Guide to Software Licensing for the Scientist-Programmer , 2012, PLoS Comput. Biol..

[26]  Jason Hennessey,et al.  A cross disciplinary study of link decay and the effectiveness of mitigation techniques , 2013, BMC Bioinformatics.

[27]  Manuel A. R. Ferreira,et al.  PLINK: a tool set for whole-genome association and population-based linkage analyses. , 2007, American journal of human genetics.

[28]  Gary D. Bader,et al.  Ten Simple Rules for Developing Public Biological Databases , 2016, PLoS Comput. Biol..

[29]  Ilkay Altintas,et al.  Ten simple rules for writing and sharing computational analyses in Jupyter Notebooks , 2019, PLoS Comput. Biol..

[30]  Veronika Cheplygina,et al.  Ten simple rules for getting started on Twitter as a scientist , 2020, PLoS Comput. Biol..