R Question 文档快捷方式

说明

这些函数提供对文档的访问。带有名称的主题的文档name(通常，一个R对象或数据集)可以通过以下任一方式显示help("name")或者?name.

用法

?topic

type?topic

参数

topic	通常，name 或字符串指定寻求帮助的主题。 或者，调用函数来请求有关相应 S4 方法的文档：请参阅有关 S4 方法文档的部分。调用 pkg::topic 和 pkg:::topic 进行特殊处理，并在包 pkg 中查找 topic 的帮助。
type	用于本主题的特殊类型的文档；例如，如果类型为 class ，则为名称为 topic 的类提供文档。有关 type 的使用，请参阅“S4 方法文档”部分，以获得有关形式方法的帮助，包括 methods?function 和 method?call 。

细节

这是 help 的快捷方式，并使用其默认的帮助类型。

有些主题需要引用(通过 backtick s)或以字符串形式给出。其中包括那些在语法上不能单独出现的运算符，例如一元和二元运算符、 function 和 control-flow reserved 单词(包括 if 、 else for 、 in 、 repeat 、 while、break 和 next)。其他 reserved 单词可以像名称一样使用，例如 TRUE 、 NA 和 Inf 。

S4 方法文档

形式(“S4”)方法的作者可以提供有关特定方法的文档，以及有关特定函数的方法的整体文档。 "?" 运算符允许通过三种方式访问此文档。

表达式 methods?f 将查找函数 f 的整体文档方法。目前，这意味着包含别名 f-methods 的文档文件。

有两种不同的方法可以查找有关特定方法的文档。第一种是以函数调用的形式提供 topic 参数，省略 type 参数。其效果是查找有关实际评估此函数调用时将使用的方法的文档。请参阅下面的示例。如果该函数不是泛型函数(没有为其定义 S4 方法)，则帮助将恢复到有关函数名称的文档。

"?" 运算符也可以通过以 method 形式提供的 type 来调用；在这种情况下，topic 参数也是函数调用，但参数现在被解释为指定参数的类，而不是在实际调用函数时出现的实际表达式。请参阅下面的示例。

如果实际调用涉及复杂的表达式，第一种方法将会很乏味，并且如果参数需要很长时间来计算，则可能会很慢。第二种方法避免了这些问题，但您必须知道计算实际参数时它们的类是什么。

两种方法都利用任何继承的方法；要查找的方法的签名是通过使用 selectMethod 找到的(请参阅 getMethod 的文档)。一个限制是，只有当导出包中的方法(与常规函数相反)的包位于搜索列表中时，才会找到它们，即使它是使用 ?package::generic() 表示法显式指定的。

例子

?lapply

?"for"                  # but quotes/backticks are needed
?`+`

?women                  # information about data set "women"

## Not run: 
require(methods)
## define a S4 generic function and some methods
combo <- function(x, y) c(x, y)
setGeneric("combo")
setMethod("combo", c("numeric", "numeric"), function(x, y) x+y)

## assume we have written some documentation
## for combo, and its methods ....

?combo  # produces the function documentation

methods?combo  # looks for the overall methods documentation

method?combo("numeric", "numeric")  # documentation for the method above

?combo(1:10, rnorm(10))  # ... the same method, selected according to
                         # the arguments (one integer, the other numeric)

?combo(1:10, letters)    # documentation for the default method

## End(Not run)

参考

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) The New S Language. Wadsworth & Brooks/Cole.

也可以看看

help

?? 用于查找模糊主题的帮助页面。