![](/img/trans.png)
[英]Using roxygen2 for R functions in an R package containing R/Cpp code
[英]How to acknowledge contributors of ideas (not code) to R package (using roxygen2)?
有人可以通过多种方式帮助 R 包,包括
author
或contributor
)contributor
)??
) 在第一种情况下, 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
角色仍然合适,如果不是,如果这些想法塑造了包的方向,即他们的想法,这是否会改变尽管他们没有编写代码,但非常重要。
美国国会图书馆将contributor
定义为
负责为资源做出贡献的个人、家庭或组织。 这包括那些为更大的作品做出贡献的人,例如选集、连续出版物或其他个人作品的汇编。 如果有更具体的角色可用,则更喜欢,例如编辑器、编译器、插图画家
另一种可能性是conceptor
对作品所基于的原始想法负责的个人或组织,包括视听项目的科学作者和广告的构思者
但这似乎表明整个工作/包是基于他们的想法(这可能是真的,但不一定)
Hadley将贡献者定义为
那些贡献较小的人,比如补丁。
对于唯一输入是想法(而不是代码)的人来说,什么是合适的角色,以及是否有其他角色可以将应有的功劳归功于为 R 包提供重要想法的人(例如README.md
中的README.md
,一个单独的文件,例如CONTRIBUTIONS
根目录中的文件,还有别的吗??)
据我所知,贡献者的描述中没有任何内容表明他们需要编写代码。
tl;dr我会根据贡献的大小在aut
和ctb
之间进行选择(正如@Dason 所说, ctb
不需要编写代码)。 因为您说“他们的想法非常重要”,所以听起来aut
是合适的。
LOC 参考很好,但来自 R-Core 的直接指导是在?person
和 Kurt Hornik(R-core 成员)的R 期刊文章中(这些来源比编写 R 扩展有更多的细节,它只是说“请参阅?person
了解更多信息。”)。 来自霍尼克的文章:
一般而言,虽然支持所有 MARC 相关代码,但在创作 R 包的上下文中指定人员角色时,建议使用以下用法:
- “aut”(作者):对软件包做出重大贡献并应出现在软件包引文中的完整作者。
- “ctb”(贡献者):贡献较小(例如代码补丁等)但不应出现在包引用中的作者[强调添加]
其他角色( com
、 cph
、 cre
、 ctr
、 dtc
、 fnd
、 rev
、 ths
、 trl
)在这里似乎都不相关。
我认为没有任何其他标准化场所可以提供贡献信息,但您可以将信息添加到别名为pkgname -package的整个包帮助文件中,或者添加到包贡献者的注释字段中:
“评论”字段可用于“任意”关于人员的附加信息。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.