帮助：文档

帮助

R文件

文档

描述

帮助是帮助系统的主要接口。

用法

帮助（主题，package=NULL，lib.loc=NULL，verbose=getOption（“verbose”），try.all.packages=getOption（“help.try.all.packages”），help_type=getOption（“help_type”）

论据

`话题`	通常，指定寻求帮助的主题。字符串（包含在显式单引号或双引号）始终被视为命名主题。如果`话题`是纵向的字符向量主题被视为唯一元素。否则`话题`必须是名称或保留名称单词（如果语法有效）或字符串。请参阅“详细信息”了解如果忽略此项会发生什么。
`包裹`	为包提供外观的名称或字符向量到以获取文档，或`无效的`。默认情况下，所有程序包将使用其命名空间。为了避免名字被删除，请使用例如。`（包装_参考）`（参见示例）。
`库.loc`	目录名的字符向量R（右）库，或`无效的`。的默认值`无效的`对应于所有当前已知的库。如果使用默认值，则加载的在库之前搜索包。这不是用于HTML帮助（请参阅“详细信息”）。
`冗长的`	逻辑；如果`真的`，报告文件名。
`try.all.包`	逻辑；看见`注释`.
`帮助类型`	字符串：所需帮助的类型。可能的值为`“文本”`，`“html”`和`“pdf”`.忽略大小写，允许部分匹配。

细节

以下类型的帮助可用：

纯文本帮助
包含指向其他主题的超链接的HTML帮助页，如浏览器依据浏览URL.
（在Unix-alikes上，在可能的情况下，重新使用现有的浏览器窗口：macOSGUI使用自己的浏览器窗口。）

如果由于某种原因HTML帮助不可用（请参阅启动动态帮助)，将使用纯文本帮助而不是。
对于帮助仅限，排版为PDF–请参阅“脱机帮助”部分。

在Unix-alikes上：: “factory-fresh”默认为文本帮助，macOS除外GUI，它使用在自己的浏览器窗口中显示的HTML帮助。
在Windows上：: 当R（右）已安装–默认的“factory-fresh”是HTML帮助。

文本帮助的呈现将在适当的语言环境（UTF-8和单字节Windows语言环境）：有时字体used不支持这些引号，因此可以通过设置选项（useFancyQuotes=FALSE）.

话题不是可选的：如果省略R（右）将给予

如果指定了包（文本或，仅在交互使用中，HTML）包上的信息，包括适当的提示/链接帮助主题。
如果库.loc仅指定，可用的（文本）列表包装。
有关的帮助帮助如果前三个都没有指定了参数。

一些主题需要引用（通过反勾号）或作为字符串。这些字符串包括语法上不能独立出现，例如一元运算符和二元运算符，功能和控制流保留字（包括如果，其他的 对于，在里面，重复，虽然，打破和下一个). 其他的保留例如，单词可以像名字一样使用真的，纳和Inf公司.

如果多个帮助文件匹配话题在交互式中找到用户可以选择一个菜单：批量使用首先使用搜索路径。（对于HTML帮助，菜单将是HTML页面，如果可能，如果getOption（“menu.graphics”）默认值为true。）

请注意，HTML帮助没有使用库.loc：它会总是先查看加载的包，然后再查看.libPaths（）.

脱机帮助

通过运行LaTeX版本的帮助页至pdflatex公司：这将生成PDF文件。

可以通过文件自定义输出的外观'Rhelp.cfg公司“LaTeX搜索路径中的某个位置：这将是输入为LaTeX样式文件斯提路.一些参考了环境变量，特别是R_放大(通过 getOption（“纸张尺寸”）)和R_RD4PDF格式（参见中的“制作手册”“R安装和管理”手册）。

如果有函数脱机帮助助手在工作区中或沿着搜索路径，它被用来进行排版，否则该名称在实用程序命名空间（到第一段适用）。它应该至少接受两个参数、要排版的LaTeX文件的名称和类型（现在被忽略了）。它接受第三个参数，特辛普茨，当帮助文件中包含数字，否则将不提供。

注释

除非库.loc显式指定时，加载的包为在指定库中搜索之前搜索。这确保了如果从不在已知库树中的库中加载库，然后使用加载的库中的帮助。如果库.loc是显式指定，加载的包是不已搜索。

如果此搜索失败并且参数try.all.包是真的两者都不是包装也不是库.loc是指定，则已知库树中的所有包都是已搜索有关的帮助话题和（任何）包列表，其中显示帮助（带有超链接help_type=“html”).注意：搜索所有包可能会很慢，尤其是第一次（操作系统缓存文件可以加快后续操作急剧搜索）。

工具书类

Becker，R.A.、Chambers，J.M.和Wilks，A.R.（1988）新S语言.沃兹沃思和布鲁克斯/科尔。

另请参见

?获取帮助主题的快捷方式。

help.search（）或??用于查找帮助页模糊话题；help.start（）打开HTML版本的R（右）帮助页面；图书馆（）列出可用软件包和它们包含的帮助对象；数据（）列出可用数据集；方法（）.

使用提示（）获得写作原型帮助您自己的包的页面。

示例

帮助（）help（help）#相同帮助（欣然）help（“for”）#或？“for”，但需要引号/反勾号try（{#需要正在运行的TeX安装：帮助（dgamma，help_type=“pdf”）##->格式良好的pdf（包括数学公式）以获取帮助（dgamma）：system2（getOption（“pdfviewer”），“dgamma.pdf”，wait=FALSE）})help（package=“splines”）#即使未加载包也可以获取帮助topi<-“女性”帮助（topi）try（help（“bs”，try.all.packages=FALSE））#找不到报告（错误）help（“bs”，try.all.packages=TRUE）#可以找到报告#包中的“样条曲线”##编程使用：主题<-“家庭”；pkg_ref<-“统计”帮助（（主题），（pkg_ref））