中文

R 包同行评审文档中的技术债务:一项 rOpenSci 案例研究

软件工程 2021-03-18 v1

摘要

背景:技术债务(Technical Debt, TD)是用于描述“不太正确”的代码的隐喻。尽管 TD 研究已获得关注,但在非面向对象(OO)或诸如 R 的科学软件中,TD 尚未被深入探究。R 是一种多范式编程语言,近年来其在数据科学与统计应用中的流行度显著提升。由于 R 可通过用户贡献的包进行扩展,若干社区主导的组织应运而生,以协同方式组织并同行评审这些包,从而提升其质量。然而,众所周知大多数 R 用户并无技术编程背景,而来自多个学科。目标:本研究旨在调查由 rOpenSci 主导的 R 包同行评审文档中的 TD。方法:我们收集了 157 个已在 rOpenSci 评审通过并发布的包中的逾 5000 条评论。我们手动分析了包作者、rOpenSci 编辑与评审者在评审过程中发布的这些评论的样本数据集,以探究这些评审中存在的 TD 类型。结果:我们的研究发现包括(i)源于同行评审分析的 TD 分类法;(ii)文档债务为最普遍的债务类型;(iii)不同用户角色关注不同类型的 TD。例如,评审者往往比其他角色报告更多某些 TD 类型,且其报告的 TD 类型不同于包作者所报告者。结论:科学软件或同行评审中的 TD 分析几乎空白。我们的研究是先驱,但限于 R 包语境。不过,鉴于我们的公开数据集,我们的发现可作为复现研究的起点,以在其他科学软件中开展类似分析或探究我们发现的背后缘由。

关键词

引用

@article{arxiv.2103.09340,
  title  = {Technical Debt in the Peer-Review Documentation of R Packages: a rOpenSci Case Study},
  author = {Zadia Codabux and Melina Vidoni and Fatemeh H. Fard},
  journal= {arXiv preprint arXiv:2103.09340},
  year   = {2021}
}