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