R bibentry 参考书目条目

说明

以增强的 BibTeX 风格表示和操作书目信息的函数。

用法

bibentry(bibtype, textVersion = NULL, header = NULL, footer = NULL,
         key = NULL, ..., other = list(),
         mheader = NULL, mfooter = NULL)

## S3 method for class 'bibentry'
print(x, style = "text", .bibstyle,
      bibtex = length(x) <= getOption("citation.bibtex.max", 1),
      ...)

## S3 method for class 'bibentry'
format(x, style = "text", .bibstyle = NULL,
       bibtex = length(x) <= 1,
       citMsg = missing(bibtex),
       sort = FALSE, macros = NULL, ...)

## S3 method for class 'bibentry'
sort(x, decreasing = FALSE, .bibstyle = NULL, drop = FALSE, ...)

## S3 method for class 'citation'
 print(x, style = "citation", ...)
## S3 method for class 'citation'
format(x, style = "citation", ...)

## S3 method for class 'bibentry'
toBibtex(object, escape = FALSE, ...)

参数

bibtype	具有 BibTeX 条目类型的字符串。有关详细信息，请参阅条目类型。
textVersion	带有参考文本表示的字符串，可以选择用于打印。如果format(x, style = "text") 工作正常，建议不指定此项。仅当需要特殊的 LaTeX 宏(例如，数学格式)或特殊字符(例如，带重音符号)时，才应提供 textVersion。
header	带有可选标题文本的字符串。
footer	带有可选页脚文本的字符串。
key	给出条目引文关键字的字符串。
...	为了bibentry: 形式的参数tag=value给出条目的字段，其中标签和值分别是字段的名称和值。具有空值的参数将被删除。字段名称不区分大小写。看输入字段详情。 对于 print() 方法，传递给渲染器的额外参数通常包括 format() 方法。 对于 citation 类方法，参数传递给下一个方法，即相应的 bibentry 方法。 对于toBibtex()方法，目前未使用。
other	... 中的参数列表(特别是对于与 bibentry 的形式名称相同的字段很有用)。
mheader	带有可选 “outer” 标题文本的字符串。
mfooter	带有可选 “outer” 页脚文本的字符串。
x	从类 "bibentry" 继承的对象。
style	指定打印样式的可选字符串。如果存在，则必须是可用样式的唯一缩写(忽略大小写)，请参阅详细信息。
decreasing	逻辑，传递给 order 指示排序方向。
.bibstyle	命名参考书目样式的字符串，请参阅bibstyle。
bibtex	logical 指示是否应另外给出BibTeX 代码；目前仅适用于 style = "citation" 。 print() 方法的默认值取决于(围兜)条目的数量和 getOption("citation.bibtex.max")(默认情况下其本身为 1)。例如，要完全看不到 bibtex，您可以通过 options(citation.bibtex.max = 0) 更改默认值。
citMsg	logical 指示是否应添加 “message”(到页脚)，了解当 bibtex 为 false 且 style = "citation" 时如何获取 BibTeX 代码。
sort	逻辑指示是否应使用 bibstyle(.bibstyle)$sortKeys(x) 对双项进行排序。
macros	字符串或已加载 Rd 宏的对象，请参阅详细信息。
drop	在 sort() 方法中用作 x[ ..., drop=drop] 的逻辑。
object	从类 "bibentry" 继承的对象。
escape	指示非 ASCII 字符是否应转换为 LaTeX 转义序列的逻辑。

细节

bibentry 创建的 bibentry 对象可以表示任意正数的引用。可以使用 c() 来组合 bibentry 对象，因此特别是从单个引用对象构建多个引用对象。或者，可以使用 bibentry 通过将参数指定为字符串列表来直接创建多引用对象。

bibentry 对象的 print 方法基于相应的 format 方法，并提供七种不同样式之间的选择：纯文本(样式 "text" )、BibTeX ( "bibtex" )、纯文本和文本的混合BibTeX 传统上用于引用 ( "citation" )、HTML ( "html" )、LaTeX ( "latex" )、R 代码 ( "R" ) 以及 textVersion 元素的简单副本 (style "textVersion")。

"text","html"和"latex"样式利用.bibstyle参数：由以下定义的样式bibstyle用于将 bibentry 渲染为(中间)Rd 格式的函数。 Rd 格式使用“编写 R 扩展”手册的“Rd 格式”部分中记录的标记命令，例如⁠\bold⁠。此外，还可以使用macros参数提供额外的(否则未知，大概是LaTeX-style)Rd 宏，或者通过提供带有要加载的 Rd 宏的文件的路径loadRdMacros，或已加载宏的对象。请注意，"latex"结果可能包含来自 LaTeX 样式文件的命令‘Rd.sty’ 附带R;放⁠\usepackage{Rd}⁠在 LaTeX 文档的序言中，以使它们在编译时可用，例如和texi2pdf.

以引用样式打印 bibentry 对象时，可以显示每个项目的 header /footer 以及整个引用向量的 mheader /mfooter。

对于格式化为 R 代码，可以选择使用 1 给出字符向量bibentry()调用每个 bibentry(如‘CITATION’ 文件)，或具有一个折叠调用的字符串，通过将各个调用与c()如果有多个 bibentry。这可以通过传递参数来控制collapse=FALSE(默认)或TRUE，分别到format()方法。 (打印在 R 风格中总是折叠为单个调用。)

可以通过键为 bibentry 对象添加下标(如果名称为 NULL 则用于字符下标)。

还有一个toBibtex 方法可以直接转换为 BibTeX。

作为R4.3.0，还有一个transform允许直接使用当前字段的方法，请参阅示例。

值

bibentry 生成 "bibentry" 类的对象。

条目类型

bibentry 创建 "bibentry" 对象，这些对象是在 BibTeX 条目之后建模的。该条目应该是有效的 BibTeX 条目类型，例如，

文章：

来自期刊或杂志的文章。

书：

有明确发布者的书。

书内：

一本书的一部分，可以是一章(或一节或其他)和/或一系列页面。

集合中：

一本书的一部分，有自己的标题。

诉讼中：

会议记录中的一篇文章。

手动的：

技术文档，例如软件手册。

硕士论文：

硕士论文。

杂项：

当没有其他合适的时候使用这种类型。

博士论文：

PhD 论文。

诉讼程序：

会议记录。

技术报告：

由学校或其他机构发布的报告，通常按系列编号。

未发表：

具有作者和标题但未正式发表的文档。

输入字段

bibentry 的 ... 参数可以是任意数量的 BibTeX 字段，包括

地址：

发布者或其他类型机构的地址。

作者：

作者姓名，可以是 person 对象，也可以是 as.person 正确强制转换为的字符串。

书名：

一本书的标题，其中的一部分被引用。

章节：

章(或节或其他)编号。

土井：

DOI(https://en.wikipedia.org/wiki/Digital_Object_Identifier)供参考。

编辑：

编辑者姓名，格式与 author 相同。

机构：

技术报告的发布机构。

杂志：

期刊名称。

笔记：

任何可以帮助读者的附加信息。第一个单词应该大写。

数字：

期刊、杂志、技术报告或系列作品的编号。

页面：

一个或多个页码或数字范围。

发布者：

发布者的名称。

学校：

撰写论文的学校的名称。

系列：

系列或一套书的名称。

标题：

作品的标题。

网址：

供参考的 URL。 (如果 URL 是扩展的 DOI，我们建议使用‘⁠多伊⁠’ 字段改为未扩展的 DOI。)

体积：

期刊或multi-volume书籍的卷数。

年：

出版年份。

例子

## R reference
rref <- bibentry(
   bibtype = "Manual",
   title = "R: A Language and Environment for Statistical Computing",
   author = person("R Core Team"),
   organization = "R Foundation for Statistical Computing",
   address = "Vienna, Austria",
   year = 2014,
   url = "https://www.R-project.org/")

## Different printing styles
print(rref)
print(rref, style = "bibtex")
print(rref, style = "citation")
print(rref, style = "html")
print(rref, style = "latex")
print(rref, style = "R")

## References for boot package and associated book
bref <- c(
   bibentry(
     bibtype = "Manual",
     title = "boot: Bootstrap R (S-PLUS) Functions",
     author = c(
       person("Angelo", "Canty", role = "aut",
         comment = "S original"),
       person(c("Brian", "D."), "Ripley", role = c("aut", "trl", "cre"),
         comment = "R port, author of parallel support",
         email = "ripley@stats.ox.ac.uk")
     ),
     year = "2012",
     note = "R package version 1.3-4",
     url = "https://CRAN.R-project.org/package=boot",
     key = "boot-package"
   ),

   bibentry(
     bibtype = "Book",
     title = "Bootstrap Methods and Their Applications",
     author = as.person("Anthony C. Davison [aut], David V. Hinkley [aut]"),
     year = "1997",
     publisher = "Cambridge University Press",
     address = "Cambridge",
     isbn = "0-521-57391-2",
     url = "http://statwww.epfl.ch/davison/BMA/",
     key = "boot-book"
   )
)

## Combining and subsetting
c(rref, bref)
bref[2]
bref["boot-book"]

## Extracting fields
bref$author
bref[1]$author
bref[1]$author[2]$email

## Field names are case-insensitive
rref$Year
rref$Year <- R.version$year
stopifnot(identical(rref$year, R.version$year))

## Convert to BibTeX
toBibtex(bref)

## Transform
transform(rref, address = paste0(address, ", Europe"))

## BibTeX reminder message (in case of >= 2 refs):
print(bref, style = "citation")

## Format in R style
## One bibentry() call for each bibentry:
writeLines(paste(format(bref, "R"), collapse = "\n\n"))
## One collapsed call:
writeLines(format(bref, "R", collapse = TRUE))

也可以看看

person