|
在线帮助
R中给予的在线帮助能提供关于如何使用函数的非常有用的信息。关于某
个特定函数的帮助能够直接被调出来,如运行:
> ?lm
会立即显示关于函数lm()(线性模型)的帮助页面。命令help(lm) 和help("lm")
具有同样的效果。但在查询关于某特殊语法意义字符的帮助时必须用后一种
形式,如:
> ?*
Error: syntax error
> help("*")
Arithmetic package:base R Documentation
Arithmetic Operators ...
启动帮助将会打开一个页面(取决于操作系统),第一行一般会显示某函数
或操作命令的所属的包(package),然后是标题,标题下面是则是一些详细信
息。
Description: brief description.
Usage: for a function, gives the name with all its arguments and the possible
options (with the corresponding default values); for an operator gives
the typical use.
Arguments: for a function, details each of its arguments.
Details: detailed description.
Value: if applicable, the type of object returned by the function or the oper-
ator.
See Also: other help pages close or similar to the present one.
Examples: some examples which can generally be executed without opening
the help with the function example.
对初学者而言,参考帮助中Examples部分的信息是很有用的。而一般
应该仔细阅读Arguments中的一些说明也是非常有必要的。帮助中还包含了
其它一些说明部分,如Note, References或Author(s)等。
默认状态下,函数help只会在被载入内存中的包中搜索。选项try.all.package
在缺省值是FALSE, 但如果把它设为TRUE,则可在所有包中进行搜索:
> help("bs")
No documentation for 'bs' in specified packages and libraries:
you could try 'help.search("bs")'
> help("bs", try.all.packages = TRUE)
Help for topic 'bs' is not in any loaded package
but can be found in the following packages:
Package Library
splines /usr/lib/R/library
但注意在这种情况下,不会显示关于函数bs的帮助页面,如果使用者确
实想打开这样的页面而所属包又没有被载入内存时,可以使用package这个选
项:
> help("bs", package = "splines")
bs package:splines R Documentation
B-Spline Basis for Polynomial Splines
Description:
Generate the B-spline basis matrix for a polynomial spline.
...
Html格式的帮助可以通过输入下面的函数启动
> help.start()
在html格式的帮助页面中还可以使用关键词进行搜索。在See Also部分
中,可以通过超文本链接到其他相关函数的帮助页面。使用关键词的搜索
在R中也可以通过函数help.search来实现。这种方法能在所有已安装的包
中搜索包含给定字符串的相关内容。例如,运行help.search("tree")会
列出所有在帮助页面含有\tree"的函数。注意如果有一些包是最近才安
装的,应该首先使用函数help.search中的rebuild选项来刷新数据库(e.g.,
help.search("tree", rebuild = TRUE))。
使用函数apropos则能找出所有在名字中含有指定字符串的函数,但只会
在被载入内存中的包中进行搜索:
> apropos(help)
[1] "help" ".helpForCall" "help.search"
[4] "help.start" |
|