Technical Release criteria
Although the editorial team may also assess the quality of the written English, please do comment if you consider the standard is below that expected for a scientific publication.
The authors should clearly state what problems the software is designed to solve and who the target audience is.
We require all source code to be openly available for reproducibility and reuse. Did the authors indicate where the software tools and relevant source code are available, under an appropriate Open Source Initiative compliant license? Test data and software also needs to be credited according to the Data Citation principles and the recommendations of the FORCE11 Software Citation Implementation Working Group
There must be clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
Can this tool be easily run on a computer? If not, please comment on what problems were encountered.
There must be enough clear information in the documentation to run this tool and information on where to seek help if required.
Please comment on any problems with installation/ deployment. Should this be handled with an automated package management solution?
A clear list of dependencies should be included. Are they using readthedocs or do they have a well documented code repository? Please comment if more is required.
If there are performance claims and are insufficiently tested, please comment. If there are no performance claims, please comment “not applicable”.
Automated testing is listed in the bioinformatics best practice checklist. Have the authors used a test framework to check the functionality of their software? If there is no automated testing, do the authors provide example data for testing their software and define what the expected results are?