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 页面的原型。