R 包的作者与贡献者 - 小代码贡献的角色是啥? [关闭]
Posted
技术标签:
【中文标题】R 包的作者与贡献者 - 小代码贡献的角色是啥? [关闭]【英文标题】:Author vs Contributor for R package - which role for small code contribution? [closed]R 包的作者与贡献者 - 小代码贡献的角色是什么? [关闭] 【发布时间】:2020-02-19 11:30:16 【问题描述】:如果有人向 R 库提供了有用的代码块,那么他们在包文档中的适当角色是什么?
为什么重要
我已经看到此类案例的贡献者角色,但在查看作者和贡献者的定义后,我认为作者是合适的角色。但可能还有其他更合适的东西(或者可能两者作者/贡献者)
library of congress 说什么
作者:
负责创作内容主要为文本的作品的个人、家庭或组织,无论媒体类型(例如印刷文本、口语、电子文本、触觉文本)或流派(例如诗歌、小说、剧本、博客)。也用于个人等通过对其他创作者的作品进行释义、改写或改编而创作新作品,从而使原作品的性质和内容发生实质性改变或改变表达媒介的行为
贡献者:
负责为资源做出贡献的个人、家庭或组织。这包括那些其作品被贡献给更大作品的人,例如选集、连续出版物或其他个人作品的汇编。如果有更具体的角色可用,则更喜欢那个角色,例如编辑器、编译器、插画家
可能的混淆点
当拉取请求被接受时,github 会将 PR 的创建者称为“贡献者” 在日常对话中,为项目提供有用意见的人可以合理地称为“贡献者”【问题讨论】:
如果您在 r-pkg-devel 列表上提问,您可能会得到不错的答复,该列表非常准确地讨论此类问题,并且许多价值贡献者不会在这里弹出。 【参考方案1】:正如前面的答案所指出的,这个想法是为了区分不同的代码贡献有多大。手册页?person
解释:
新方案还增加了指定角色的可能性 基于关系者的 MARC 代码列表的子集(URL: https://www.loc.gov/marc/relators/relaterm.html)。给的时候 人在创作 R 包的上下文中的角色, 建议使用以下用法。
"aut"
(Author) 用于已做出实质性贡献的完整作者 对包的贡献,并应显示在包引用中。"cre"
(创建者)用于包维护者。"ctb"
(Contributor) 用于缩小规模的作者 贡献(例如代码补丁等)但不应显示 在包引用中。
那里还提供了在 R 包上下文中使用更多角色的建议("com"
、"cph"
、"ctr"
、"dtc"
、"fnd"
、"rev"
、"ths"
、@ 987654334@)。如果包“foo”没有专用的 CITATION 文件,上述引用是您从 citation("foo")
获得的“默认”或“自动”引用。如果有,您仍然可以通过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
【讨论】:
【参考方案2】:我认为这是一个非常有趣的问题,我之前也想过这个问题。
很遗憾,我认为您提供的两个定义并不像您想象的那么清楚。一个问题是,根据您阅读它们的方式,您可能会争辩说作者和贡献者都是在包中编写代码的人的正确标签。看看定义中使用的类别中的 R 包是什么:
您可以将一个包视为“内容主要是文本的作品,无论媒体类型如何”——在这种情况下,写在上面的人就是作者——或者“个人作品的汇编”—— - 在这种情况下,添加个人作品(例如函数)的人将成为贡献者。
在 Hadley Wickham 的“R 包”一书中,section about the author 必须说以下内容:
cre:创建者或维护者,如果你应该打扰的人 有问题。
aut:作者,对 包。
ctb:贡献者,贡献较小的人,比如 补丁。
(这个原文好像是这篇文章:Hornik, Murdoch and Zeileis (2012))
使用贡献的大小来确定某人是作者还是贡献者似乎是处理区别的好方法。
留下一个实质性贡献的问题。最终,我认为这必须在作者和贡献者之间进行协商。理想情况下,创建者/维护者制定了指导方针,或者在可能的 PR 之前讨论了该问题。
我在此建议的一个经验法则是询问软件包的核心功能是否会在没有一个人的贡献的情况下存在。如果答案是“否”,那么这个人就是作者。如果答案是“是的,但它们不会那么好用”,我认为这个人应该是贡献者。
【讨论】:
以上是关于R 包的作者与贡献者 - 小代码贡献的角色是啥? [关闭]的主要内容,如果未能解决你的问题,请参考以下文章
R语言DALEX包的explain函数生成指定分类预测机器学习模型解释器predict_parts函数基于breakdown方法分析对于指定的某一条样本(实例观察)每个变量对于预测结果的贡献大小
R语言使用DALEX包的explain函数生成指定分类预测机器学习模型的解释器predict_parts函数基于shap方法分析对于指定的某一条样本(实例观察)每个变量对于预测结果的贡献大小