![](/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.