1.8　獲取函數的幫助文檔

1.8.1　問題

了解已經安裝在計算機上的某個函數的更多信息。

1.8.2　解決方案

通過help函數查看該函數的幫助文檔。例如：

---

help(functionname)

---

用args函數快速獲取函數的參數。例如：

---

args(functionname)

---

用example函數查看函數的使用示例。例如：

---

example(functionname)

---

1.8.3　討論

本書將介紹許多R函數，但每個R函數都有很多功能，無法在本書中逐一介紹。如果讀者對某個函數感興趣，我們強烈推薦閱讀關于該函數的幫助頁面，你或許會從中獲取有幫助的信息。

例如，想了解mean函數的全部功能，使用help命令查詢該函數，例如：

---

help(mean)

---

這將在RStudio的幫助窗格中打開mean函數的幫助頁面。help命令的快捷方式是簡單輸入?并后跟函數名稱：

---

?mean

---

有時你僅想快速了解函數的參數：函數中有哪些參數？參數的順序是什么？此時可以使用args函數。例如：

---

args(mean)
#> function (x, ...)
#> NULL

args(sd)
#> function (x, na.rm = FALSE)
#> NULL

---

其中第一行的輸出結果為該函數的調用簡介。上面輸出mean函數的調用簡介，其中包含一個名為x的參數，它是一個數值向量。對于sd函數而言，args命令顯示了它有和mean一樣的一個x向量以及一個名為na.rm的可選參數（可以忽略第二行的結果，因為一般其結果都是NULL）。在RStudio中，當鍵入函數名時，你將看到args輸出作為浮動工具提示，如圖1-5所示。

圖1-5：RStudio工具提示

R軟件的函數幫助文檔在最后一般都給出具體的使用例子。R的一個很誘人的特性是，可以使用example命令查看函數例子的具體執行，它可以演示該函數的功能。例如，對于mean函數的幫助文檔，它含有一些示例，不必手動輸入這些代碼示例。只要使用example函數便能執行它。例如：

---

example(mean)
#>
#> mean> x <- c(0:10, 50)
#>
#> mean> xm <- mean(x)
#>
#> mean> c(xm, mean(x, trim = 0.10))
#> [1] 8.75 5.50

---

你在輸入example(mean)后看到的所有內容都由R生成，它執行幫助頁面中的示例并顯示結果。

1.8.4　另請參閱

參考1.9節來查找某一函數；參考3.6節來查看更多搜索路徑。