如何(使用roxygen2)认可R包的想法(不是代码)的贡献者?

时间:2020-02-03 00:04:23

标签: r cran roxygen2

有人可以通过多种方式为R包提供帮助,包括

  1. 大量原始代码/想法(authorcontributor
  2. 一些琐碎的代码(例如,修正拼写错误)(可能是contributor
  3. 没有代码,但提供了想法或领域专业知识(??

首先,最适合使用author角色。在roxygen2中,可能看起来像这样(aut):

Authors@R: c(
    person("Hadley", "Wickham", , "hadley@rstudio.com", c("aut", "cre"), comment = c(ORCID = "0000-0003-4757-117X")),
    person("Romain", "Fran\u00e7ois", role = "aut", comment = c(ORCID = "0000-0002-2444-4226")),
    person("Lionel", "Henry", role = "aut"),
    person("Kirill", "M\u00fcller", role = "aut", comment = c(ORCID = "0000-0002-1416-3412")),
    person("RStudio", role = c("cph", "fnd"))
    )

在第二种情况下,contributor角色可能(或可能不)合适。例如

Authors@R: c(
    person("Some", "One", , "someone@rstudio.com", c("ctb"))

但是,当有人在想法/讨论/领域专业知识方面提供帮助,而 没有 贡献代码时(案例3),contributor角色仍然合适,如果没有,那么,如果创意改变了包装的方向,这是否会改变-即尽管他们的想法没有编写代码,但他们的想法仍然非常重要。

到目前为止我所知道的

Library of Congresscontributor定义为

负责为资源做出贡献的个人,家庭或组织。这包括那些其工作已促成更大作品的人,例如选集,系列出版物或其他个人作品的汇编。如果可以使用更具体的角色,请选择该角色。编辑器,编译器,插画家

另一种可能性是conceptor

负责作品所基于的原始思想的个人或组织,其中包括视听项目的科学作者和广告的概念设计者

但这似乎表明整个工作/软件包是基于他们的想法(可以是正确的,但不一定)

其他参考

Hadley将贡献者定义为

贡献较小的人,例如补丁。

问题

仅输入 的人是想法(不是代码)的人的合适角色是什么,还有其他方法可以将应有的荣誉归功于向R程序包提供重要想法的人(例如,注释)在README.md中,是一个单独的文件,例如根目录中的CONTRIBUTIONS文件,还有其他内容?)

2 个答案:

答案 0 :(得分:2)

在贡献者的描述中没有任何内容表明他们需要编写代码。

答案 1 :(得分:2)

tl; dr 我会根据贡献的大小在autctb之间进行选择(正如@Dason所说,ctb不需要已编写代码)。因为您说“他们的想法非常重要”,听起来aut才是合适的。

LOC引用很好,但是R-Core的 direct 指导在?person和Kurt Hornik的(R核心成员)R Journal article中(这些来源有更多而不是Writing R Extensions的详细信息,后者只是说“请参阅?person了解更多信息。”)。来自Hornik的文章:

通常,虽然支持所有MARC关联程序代码,但在创作R的背景下赋予人物角色时,建议使用以下用法 包:

  • “ aut”(作者):对软件包和 应该出现在包装引用中。
  • “ ctb”(撰稿人): 较小的贡献(例如代码补丁等),但不应显示在包装中 引文[重点添加]

没有其他角色(comcphcrectrdtcfndrevthstrl)在这里似乎很重要。

我认为没有其他标准化的场所可以提供贡献信息,但是您可以将信息添加到整个软件包帮助文件aliased to pkgname-package或在软件包贡献者的注释字段中:

“注释”字段可用于“任意”附加 有关人员的信息。