在R包中添加引用信息

guykilcj  于 2023-04-09  发布在  其他
关注(0)|答案(3)|浏览(126)

我正在使用Roxygen2devtools构建我的R包,我想在我的R代码中添加一些引用信息(即我希望写一个.R文件,从这个文件中可以自动生成引文)。最终目标是显示,一旦我运行命令citation(MyPkgName),引用的R包以及引用(最好是BibTeX条目)的论文我提交.有没有办法做到这一点使用devtools?谢谢!

5kgi1eie

5kgi1eie1#

CITATION文件应该在inst目录中。有关文件中应该包含的内容的详细信息,请参阅官方文档。

ikfrs5lh

ikfrs5lh2#

需要在目录“yourPackage/inst/”中创建一个名为“CITATION”的文件。可以使用以下命令自动创建文件CITATION

usethis::use_citation()

此文件将包含一个未填写的模板,其中包含空白字段用于引用信息(例如,作者,期刊,年份等)。您需要填写空白。

atmip9wb

atmip9wb3#

在包中包含引用的另一种方法是在附加时间(例如,使用library()时)。
您可以使用函数.onAttach()(它可以放在zzz.R文件中,如Hadley's R Packages book中所建议的那样)。
一个例子是:

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

但是你可以很容易地在网络上搜索其他例子,比如this one包括对citation()的调用。

相关问题