← 返回学术指南

期刊投稿材料 · 2026/10/25

投PLOS Computational Biology软件论文,代码包与测试数据要备到什么程度?

区分持续开发的代码仓库与论文对应的归档版本,说明源码、许可、安装说明、测试数据和可复现输出的准备方法。

软件在公开仓库里能运行,不等于已经备齐 PLOS Computational Biology 的 Software 论文材料。该刊要求工具具有面向较广用户群的用途,源码可匿名下载,采用符合开放源代码倡议标准的许可,并让读者能从源码安装、用所给测试数据重现展示的功能。投稿时要把两个版本分开:公开仓库可继续开发,随论文归档的那一版则必须对应文中的结果。

先让陌生读者从源码跑起来

给项目附一份从零开始的说明:支持的操作系统、语言和依赖版本、下载与构建命令、安装后的最小运行命令。若项目是程序库,还要说明怎样调用接口;若依赖专有软件,也应如实列出,让读者知道实际门槛。还可让测试者从一台未装开发环境的电脑开始,按同一说明逐条执行;能否复现比作者机器上的成功截图更能发现遗漏的依赖。只把可执行程序放在下载页,不能替代源码和构建说明。若仓库需要登录、邮件申请或机构账号,先检查是否满足该刊“匿名下载源码”的条件。

测试数据不是装饰性附件。选择能覆盖论文展示的关键功能的一小套数据,同时给出输入文件、运行参数、命令与预期输出。假设论文用一个网络模型分析基因调控,测试包至少要让读者找到示例网络、参数文件,以及文中展示结果如何从该输入得到;不必把无法合法共享的真实敏感数据硬塞进去。若外部数据库可能更新,说明使用的版本或获取时间,否则同一命令以后得到不同输出,也难以判断是软件还是输入改变。

把论文版本固定下来

该刊把归档软件、测试数据、参数和文档视为与文章对应的记录副本,要求作为补充材料提交,并给出小于 100 MB 的文件上限。持续开发的公开仓库仍可保留,但应为投稿版本打标签,核对归档包与论文的算法描述、示例输出一致。文件太大时先区分必需的记录副本与可引用的较大外部数据,再按投稿说明安排;不要把一个只指向会不断变化的主分支的链接当作固定版本。

最后请没有参与开发的同事按文档试一次。记录他是否能找到许可、源码、依赖、测试数据和论文中那幅结果对应的参数,并让他保存实际产生的输出文件,和作者提供的预期输出逐项比较。如果还要作者口头解释某个隐藏配置,说明软件包尚未成为可供审阅的材料。封面信则要说明工具给哪个生物学研究群体使用、为何是实质进展,并指向已经准备好的下载与归档信息,而不是只罗列功能名称。