||
使用他人代码的十条简单规则
每次你使用计算机时,你都在使用别人的代码,无论是操作系统、文字处理器、网络应用程序、研究工具,还是简单的代码片段。几乎所有的代码都有一些bug和错误。在日常生活中,这些错误通常并不太重要,或者至少在它们发生时并不明显(想想操作系统崩溃)。然而,在研究中,有一场完美的风暴使使用他人的代码变得特别具有挑战性。研究需要正确和准确,研究人员经常使用没有最佳软件实践的软件和非商业工具,漏洞可能很微妙并且很难检测,研究人员有时间压力快速完成任务。因此,对研究人员来说,使用他人的代码是一种常见的挫败感,甚至被认为是一种成人仪式,这一点也就不足为奇了。
学术界有大量关于如何编写更好代码的资源,包括PLOS ONE关于再现性、文档和编写开源软件的“十条简单规则”文章。有人呼吁通过发布代码并确保其可重复使用来提高研究的可重复性。然而,在研究中使用他人代码的反问题并没有得到那么多的关注。在工业中,有一些资源用于处理遗留代码(“遗留代码”本质上翻译为“其他人的代码”)。虽然行业软件开发实践是有用的,但它们通常不能盲目地应用于研究软件开发,而是需要进行调整。因此,Pilgrim等人在《Ten simple rules for working with other people's code》中提出的方法是汇集和整合行业、现有文献以及作者及其同事的研究经验。
Pilgrim等人提出的10条规则对从学生到教授的各级学术研究人员都很有用。其重点是务实的研究效率,而不是可能带来不切实际的时间负担的绝对最佳实践。这些规则是知情的,但有主见。因此,鼓励读者以这些规则为出发点,为自己思考,做对自己有利的事情。总的来说,如果读者能从这篇文章中获得一个有用的想法或想法,那么就会认为它是成功的。
这10条规则如下:
规则1:明确你的目标
规则2:选择你的代码库
规则3:阅读文档
规则4:找出如何运行它
规则5:测试它能达到你的预期
规则6:把它分解并画出来
规则7:寻求帮助
规则8:在做出改变之前先思考
规则9:使用版本控制
规则10:发布
以上10条规则可以分为计划、理解、更改和发布四个类别,它们之间呈现互相反馈的关系(图1)。每条规则的详细注意事项可以参见文献[1]。
图1 这10条规则可以分为计划、理解、更改和发布四个类别。使用他人代码不是一个循序渐进的过程。当你建立对代码的理解时,你的目标可能会改变,这将影响你如何以及是否做出改变。
参考文献
[1] Pilgrim C, Kent P, Hosseini K, Chalstrey E. Ten simple rules for working with other people's code. PLoS Comput Biol. 2023 Apr 20;19(4):e1011031. doi: 10.1371/journal.pcbi.1011031.
以往推荐如下:
5. EMT标记物数据库:EMTome
8. RNA与疾病关系数据库:RNADisease v4.0
9. RNA修饰关联的读出、擦除、写入蛋白靶标数据库:RM2Target
13. 利用药物转录组图谱探索中药药理活性成分平台:ITCM
Archiver|手机版|科学网 ( 京ICP备07017567号-12 )
GMT+8, 2024-12-4 21:24
Powered by ScienceNet.cn
Copyright © 2007- 中国科学报社