在R包中添加引文信息

Question

我正在使用Roxygen2和devtools构建我的R包，我想在我的R代码中添加一些引用信息（即我希望用{{1}写一下可以自动生成引文的文件）。一旦我运行命令.R， R软件包的引用以及论文的引用（最好用BibTeX条目），最终目标是显示强>我提交。有没有办法使用citation(MyPkgName)来做到这一点？谢谢！

Answer 1

CITATION文件应位于inst目录中。有关文件中应包含的内容的详细信息，请参阅official documentation。

Answer 2

CITATION模板可以使用

自动创建

usethis::use_citation()

创建文件后，您只需要填补空白即可。

Answer 3

将引文包含在包装中的另一种方法是在附加时间内（例如，使用library()时）。

您可以使用功能.onAttach()（它可以放入zzz.R文件中，如Hadley's R Packages book中的建议）。

一个例子是：

.onAttach<-function(libname, pkgname){
      packageStartupMessage('Please cite this paper!') 
}

但是您可以轻松地在网上搜索其他示例，例如this one，包括对citation()的调用。