R help 文檔

說明

help 是幫助係統的主要接口。

用法

help(topic, package = NULL, lib.loc = NULL,
     verbose = getOption("verbose"),
     try.all.packages = getOption("help.try.all.packages"),
     help_type = getOption("help_type"))

參數

topic	通常，name 或字符串指定尋求幫助的主題。字符串(用明確的單引號或雙引號引起來)始終被視為命名主題。 如果 topic 的值是長度為 1 的字符向量，則該主題將被視為唯一元素的值。否則topic 必須是名稱或reserved 單詞(如果語法有效)或字符串。 請參閱“詳細信息”了解如果省略此選項會發生什麽情況。
package	提供要查找文檔的包的名稱或字符向量，或 NULL 。默認情況下，使用加載了名稱空間的所有包。為了避免名稱被解析，請使用例如(pkg_ref)(參見示例)。
lib.loc	目錄名稱的字符向量R Library ，或NULL.默認值為NULL對應於當前已知的所有庫。如果使用默認值，則在庫之前搜索加載的包。這不用於 HTML 幫助(請參閱“詳細信息”)。
verbose	邏輯性；如果 TRUE ，則報告文件名。
try.all.packages	邏輯性；請參閱Note。
help_type	字符串：所需幫助的類型。可能的值為 "text" 、 "html" 和 "pdf" 。忽略大小寫，並且允許部分匹配。

細節

可以使用以下類型的幫助：

• 純文本幫助

• 帶有指向其他主題的超鏈接的 HTML 幫助頁麵，通過以下方式顯示在瀏覽器中browseURL.
  (在類似 Unix 係統上，可能會重複使用現有的瀏覽器窗口：macOS GUI 使用自己的瀏覽器窗口。)

  如果由於某種原因 HTML 幫助不可用(請參閱 startDynamicHelp )，將使用純文本幫助。

• 僅適用於 help，排版為 PDF - 請參閱“離線幫助”部分。

在 Unix 類係統上：

“factory-fresh”默認為文本幫助，macOS GUI 除外，它使用在其自己的瀏覽器窗口中顯示的 HTML 幫助。

在 Windows 上：

在以下情況下選擇幫助類型的默認值：R已安裝 - “factory-fresh”默認為 HTML 幫助。

文本幫助的呈現將在合適的語言環境(UTF-8 和單字節 Windows 語言環境)中使用定向引號：有時使用的字體不支持這些引號，因此可以通過設置 options(useFancyQuotes = FALSE) 來關閉此函數。

topic不是可選的：如果省略R會給

• 如果指定了包，則有關包的信息(文本或僅在交互式使用中為 HTML)信息，包括指向合適幫助主題的提示/鏈接。

• 如果僅指定 lib.loc，則為可用包的(文本)列表。

• 如果未指定前三個參數，則有關 help 本身的幫助。

有些主題需要引用(通過 backtick s)或以字符串形式給出。其中包括那些在語法上不能單獨出現的運算符，例如一元和二元運算符、 function 和 control-flow reserved 單詞(包括 if 、 else for 、 in 、 repeat 、 while、break 和 next)。其他 reserved 單詞可以像名稱一樣使用，例如 TRUE 、 NA 和 Inf 。

如果找到與 topic 匹配的多個幫助文件，則在交互式使用中，會出現一個菜單供用戶選擇一個：在批量使用中，使用搜索路徑上的第一個。 (對於 HTML 幫助，菜單將是一個 HTML 頁麵，否則如果可能的話，如果 getOption("menu.graphics") 為 true(默認值)，則為圖形菜單。)

請注意，HTML 幫助不使用 lib.loc ：它始終首先在加載的包中查找，然後沿著 .libPaths() 查找。

離線幫助

排版文檔是通過 pdflatex 運行幫助頁麵的 LaTeX 版本來生成的：這將生成一個 PDF 文件。

輸出的外觀可以通過文件'定製Rhelp.cfg’ 在 LaTeX 搜索路徑中的某個位置：這將在之後作為 LaTeX 樣式文件輸入Rd.sty。一些環境變量被谘詢，特別是R_PAPERSIZE(通過 getOption("papersize")) 和R_RD4PDF(請參閱“R 安裝和管理”手冊中的“製作手冊”)。

如果工作區或搜索路徑中存在函數 offline_help_helper，則該函數用於進行排版，否則使用 utils 命名空間中的該名稱的函數(第一段適用)。它應該至少接受三個參數，即要排版的 LaTeX 文件的名稱、類型(現在已被忽略)以及邏輯 msg(指示是否應發出有關 pdf 創建的 message() 信號)。它還接受一個參數 texinputs ，當幫助文檔包含圖形時，它將給出圖形路徑，否則不會提供。

注意

除非顯式指定lib.loc，否則將在指定庫中的包之前搜索加載的包。這確保了如果從不在已知庫樹中的庫加載庫，則使用已加載庫的幫助。如果顯式指定lib.loc，則不會搜索加載的包。

如果此搜索失敗並且參數 try.all.packages 是 TRUE 並且既沒有指定 packages 也沒有指定 lib.loc，則在已知庫樹中的所有包中搜索 topic 的幫助和(任何)包列表顯示可以找到幫助的位置(帶有 help_type = "html" 的超鏈接)。注意：搜索所有包可能會很慢，尤其是第一次(操作係統緩存文件可以顯著加快後續搜索速度)。

例子

help()
help(help)              # the same

help(lapply)

help("for")             # or ?"for", but quotes/backticks are needed

try({# requires working TeX installation:
 help(dgamma, help_type = "pdf")
 ## -> nicely formatted pdf -- including math formula -- for help(dgamma):
 system2(getOption("pdfviewer"), "dgamma.pdf", wait = FALSE)
})

help(package = "splines") # get help even when package is not loaded

topi <- "women"
help(topi)

try(help("bs", try.all.packages = FALSE)) # reports not found (an error)
help("bs", try.all.packages = TRUE)       # reports can be found
                                          # in package 'splines'

## For programmatic use:
topic <- "family"; pkg_ref <- "stats"
help((topic), (pkg_ref))

參考

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) The New S Language. Wadsworth & Brooks/Cole.

也可以看看

? 用於幫助主題的快捷方式。

help.search()或者??用於查找有關模糊主題的幫助頁麵；help.start()這將打開 HTML 版本的R幫助頁麵；library()用於列出可用的包及其包含的幫助對象；data()用於列出可用的數據集；methods().

使用prompt() 獲取用於編寫您自己的包的help 頁麵的原型。