R citation 在出版物中引用 R 和 R 包

说明

如何引用R和R出版物中的包。

用法

citation(package = "base", lib.loc = NULL, auto = NULL)

readCitationFile(file, meta = NULL)
citHeader(...)
citFooter(...)

参数

package	带有单个包名称的字符串。如果给出多个包名称，则会发生错误。
lib.loc	路径名称为的字符向量R库，或包含源的目录package， 或者NULL.默认值为NULL对应于当前已知的所有库。如果使用默认值，则在库之前搜索加载的包。
auto	指示默认引文是否从包自动生成的逻辑‘DESCRIPTION’ 是否应该使用元数据，或者NULL(默认)，表示‘CITATION' 如果存在则使用文件，或者类的对象"packageDescription"带有包元数据(见下文)。
file	一个文件名。
meta	通过 packageDescription 或 NULL (默认值)获取的包元数据列表。
...	字符串(将是 paste d)。

细节

R核心开发团队和非常活跃的软件包作者社区投入了大量的时间和精力来创建R就像今天一样。请在应注明的地方注明表示R和R当您使用它们进行数据分析时。

执行函数citation()有关如何在出版物中引用基本 R 系统的信息。如果给出了非基础包的名称，该函数或者返回“CITATION' 包的文件(使用readCitationFile和meta等于packageDescription(package, lib.loc))或来自‘的auto-generates引用信息DESCRIPTION' 文件。

包可以使用‘⁠作者@R⁠' 他们的领域'DESCRIPTION' 提供 (R代码给出)aperson对象，具有包 “authors” 的精炼的、机器可读的说明(特别是指定它们的精确角色)。只有具有作者角色的人才会包含在自动生成的引文中。

如果 citation() 返回的对象仅包含一个引用，则关联的 print 方法会显示它的文本版本和 BibTeX 条目。如果一个包有多个参考，则仅显示文本版本。该阈值由options("citation.bibtex.max") 控制。 BibTeX 版本也可以使用函数 toBibtex() 获取(请参阅下面的示例)。

这 'CITATION’ R 包的文件应放置在‘安装’ 包源的子目录。该文件是 R 源文件，可能包含任意 R 命令，包括条件和计算。函数readCitationFile()被使用citation()提取‘中的信息CITATION’文件。该文件是source()由 R 解析器在临时环境中编辑，以及所有生成的书目对象(具体来说，继承自"bibentry")被收集。这些通常由一个或多个生产bibentry()调用，可选地在前面加上citHeader()然后是一个citFooter()称呼。可以在‘CITATION’ 文件通过citation(auto = meta).

readCitationFile 利用meta 的Encoding 元素(如果有)来确定文件的编码。

值

类 "citation" 的对象，继承自类 "bibentry" ；请参阅此处，特别是 print 和 format 方法。

citHeader 和 citFooter 返回一个空的 "bibentry"，存储包引用的 “outer” 页眉/页脚文本。

例子

## the basic R reference
citation()

## extract the BibTeX entry from the return value
x <- citation()
toBibtex(x)

## references for a package
citation("lattice")
citation("lattice", auto = TRUE)  # request the Manual-type reference
citation("foreign")

## a CITATION file with more than one bibentry:
file.show(system.file("CITATION", package="mgcv"))
cm <- citation("mgcv")
cm # header, text references, plus "reminder" about getting BibTeX
print(cm, bibtex = TRUE) # each showing its bibtex code

## a CITATION file including citation(auto = meta)
file.show(system.file("CITATION", package="nlme"))
citation("nlme")

也可以看看

bibentry