當前位置: 首頁>>代碼示例 >>用法及示例精選 >>正文


R help.start 超文本文檔


R語言 help.start 位於 utils 包(package)。

說明

啟動超文本(當前為 HTML)版本R的在線文檔。

用法

help.start(update = FALSE, gui = "irrelevant",
           browser = getOption("browser"), remote = NULL)

參數

update

邏輯:是否應該嘗試更新包索引以反映當前可用的包。 (如果 remote 不是 NULL,則不會嘗試。)

gui

隻是為了與S-PLUS兼容。

browser

用作超文本瀏覽器的程序的名稱。它應該在PATH,或指定的完整路徑。或者,它可以是R將使用 URL 作為唯一參數來調用該函數。當使用 file-association 機製時,通常在 Windows 上取消設置此選項。

remote

給出‘的有效 URL 的字符串base Rhome' 遠程位置上的目錄。

細節

除非指定 remote ,否則需要 HTTP 服務器可用(如果可能,它將啟動:請參閱 startDynamicHelp )。

索引頁上的鏈接之一是 HTML 包索引,‘R.home("docs")/html/packages.html’,可以通過以下方式重新製作make.packages.html()。對於本地操作,當第一次單擊鏈接時,HTTP 服務器將重新製作此列表的臨時版本,並且此後每次檢查是否需要更新(如果.libPaths已更改或任何目錄已更改)。這可能會很慢,並且使用update = TRUE將確保在啟動索引頁麵之前更新軟件包列表。

參數remote可用於指向其他人發布的 HTML 幫助R安裝:它通常隻顯示該安裝的主庫中的包。

例子

help.start()
## Not run: 
if(.Platform$OS.type == "unix") # includes Mac
  ## the 'remote' arg can be tested by
  help.start(remote = paste0("file://", R.home()))

## End(Not run)

也可以看看

help() 用於其他格式的on- 和off-line 幫助。

browseURL 了解如何顯示幫助文件。

RSiteSearch訪問 on-line 搜索R資源。

相關用法


注:本文由純淨天空篩選整理自R-devel大神的英文原創作品 Hypertext Documentation。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。