help.start
位于 utils
包(package)。 说明
启动超文本(当前为 HTML)版本R的在线文档。
用法
help.start(update = FALSE, gui = "irrelevant",
browser = getOption("browser"), remote = NULL)
参数
update |
逻辑:是否应该尝试更新包索引以反映当前可用的包。 (如果 |
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 help.search 搜索帮助系统
- R help.request 向 R-help 发送帖子
- R help 文档
- R head 返回对象的第一部分或最后部分
- R hasName 检查姓名
- R hsearch-utils 帮助搜索实用程序
- R hashtab 哈希表(实验)
- R select.list 从列表中选择项目
- R COMPILE 编译用于 R 的文件
- R readRegistry 读取 Windows 注册表配置单元
- R browseVignettes 在 HTML 浏览器中列出晕影
- R nsl 按主机名查找 IP 地址
- R edit 调用文本编辑器
- R create.post 准备电子邮件和帖子的辅助函数
- R download.packages 从类似 CRAN 的存储库下载软件包
- R DLL.version MS Windows 上的 DLL 版本信息
- R ls.str 列表对象及其结构
- R Rscript R 前端脚本
- R bug.report 发送错误报告
- R PkgUtils 用于构建和检查附加包的实用程序
- R cite 引用参考书目条目
- R SweaveSyntConv 转换 Sweave 语法
- R RSiteSearch 搜索文档中的关键词或短语
- R glob2rx 将通配符或通配符模式更改为正则表达式
- R getFromNamespace 用于开发命名空间的实用函数
注:本文由纯净天空筛选整理自R-devel大神的英文原创作品 Hypertext Documentation。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。