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

?? 用於查找模糊主題的幫助頁麵。