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