正如之前的答案所指出的,这个想法是区分不同代码贡献的重要性。手册页?person
解释:
新方案还增加了根据 MARC 代码列表的子集指定角色的可能性(URL: https
://www.loc.gov/marc/relators/relaterm.html
)。在编写 R 包的上下文中赋予人员角色时,建议使用以下用法。
"aut"
(作者)用于对包做出重大贡献并应出现在包引用中的完整作者。
"cre"
(创建者)用于包维护者。
"ctb"
(贡献者)用于贡献较小(例如代码补丁等)但不应出现在包引用中的作者。
那里还提供了在 R 包的上下文中使用更多角色的建议("com"
, "cph"
, "ctr"
, "dtc"
, "fnd"
, "rev"
, "ths"
, "trl"
)。citation("foo")
如果包“foo”没有专用的 CITATION 文件,上述引用是您从中获得的“默认”或“自动”引用。如果有,您仍然可以通过citation("foo", auto = TRUE)
. 有关?citation
更多详细信息,请参阅。
回到“作者”与“贡献者”的问题:当我们编写上述文档(以及霍尼克等人在 The R Journal 中的随附论文)时,我们故意只给出粗略的指导方针,因为最终决定什么是“实质性的”足够”需要由包作者自己制作。这与决定将谁包括在科学论文的作者列表中与在致谢中提及的决定并不相似——为此,不同学科/社区的实践也有很大差异。
一种常见的策略是区分三个贡献级别:
- 那些做出很小贡献的人(如小的修复或改进)不会在描述中列出,但会在新闻或变更日志中得到承认。这适用于通过错误/问题跟踪器或 GitHub 或类似平台上的小型拉取请求做出的许多小贡献。
- 那些提供较大补丁、小型辅助功能、针对特定情况的附加功能等的人应在说明中列为“贡献者”(ctb)。这也适用于从其他包或其他来源复制代码部分的情况。
- 那些做出更大和/或持续贡献的人,这些贡献足以在说明和包的默认/自动引用中列为“作者”(aut)。
参考: Hornik K、Murdoch D、Zeileis A (2012)。“谁做了什么?R 包作者的角色以及如何引用他们。” R 杂志,4 (1),64-69。doi:10.32614/RJ-2012-009