当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


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。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。