如何在 R 中获得帮助?

How to get help in R?

提问人:Tomas Greif 提问时间:3/8/2013 最后编辑:Richie CottonTomas Greif 更新时间:8/25/2021 访问量:37518

问:

R 包有哪些可能的文档?例如,我尝试理解包。sp

除了 之外,还有哪些其他功能可以搜索帮助和文档?help(sp)

R-常见问题

评论

0赞 IRTFM 3/3/2017
对该软件包最直接的帮助将来自它应该打开索引页面。help(pac=sp)

答:

64赞 Tomas Greif 3/8/2013 #1

获取有关您知道其名称的函数的帮助

使用 或等效地使用 help

?mean
help(mean) # same

对于非标准名称,请使用引号或反引号;请参阅 R 简介:获取有关函数和特性的帮助:

对于由特殊字符指定的功能,参数必须用双引号或单引号括起来,使其成为“字符串”: 对于一些具有句法含义的单词(包括 和 )来说,这也是必需的。ifforfunction

?`if`
?"if"       # same
help("if")  # same

还有数据集、一般主题和一些包的帮助页面。

?iris
?Syntax
?lubridate    

使用示例函数查看如何使用它的示例

example(paste)
example(`for`)

演示函数提供了如何使用函数的更长的演示

demo()                           # all demos in loaded pkgs
demo(package = .packages(all.available = TRUE)) # all demos
demo(plotmath)
demo(graphics)

查找您不知道其名称的函数

使用 或者,等效地使用 help.search??

??regression
help.search("regression")

同样,需要引用非标准的名称和短语。

??"logistic regression"

apropos 在当前会话空间中查找与正则表达式匹配的函数和变量(但不在已安装但未加载的包中)。

apropos("z$") # all fns ending with "z"

rseek.org 是一个带有 Firefox 插件的 R 搜索引擎。

RSiteSearch 直接从 R 搜索多个站点。

findFn 换行,以 HTML 表格的形式返回结果。sosRSiteSearch

RSiteSearch("logistic regression")

library(sos)
findFn("logistic regression")

查找软件包

available.packages 会告诉您通过 setRepositories 设置的存储库中可用的所有包。installed.packages 告诉您在 .libPaths 中指定的所有库中安装的所有软件包。(不带任何参数)与此类似,返回已安装软件包的名称和标语。

View(available.packages())
View(installed.packages())
library()
.libPaths()

同样,不带参数的数据会告诉您计算机上有哪些数据集可用。

data()

搜索会告诉您已加载哪些包。

search()

packageDescription 显示包文件的内容。同样 新闻 阅读文件。DESCRIPTIONNEWS

packageDescription("utils")    
news(package = "ggplot2")

获取有关变量的帮助

LS 列出环境中的变量。

ls()                 # global environment
ls(all.names = TRUE) # including names beginning with '.'
ls("package:sp")     # everything for the sp package

大多数变量都可以使用 strsummary 进行检查。

str(sleep)
summary(sleep)

ls.str 就像 和 的组合。lsstr

ls.str()
ls.str("package:grDevices")
lsf.str("package:grDevices")  # only functions    

对于大型变量(尤其是数据帧),head 函数可用于显示前几行。

head(sleep)

args 显示函数的参数。

args(read.csv)

关于 R 的一般学习

“信息”页是一组非常全面的免费 R 资源链接。

R 中的许多主题都通过小插图s 记录,并与 browseVignettes 一起列出。

browseVignettes()
vignette("intro_sp", package = "sp")

通过与编辑结合使用,您可以在编辑器中获取其代码块。vignette

edit(vignette("intro_sp",package="sp"))    

评论

2赞 Ben Bolker 3/8/2013
news(package="sp")(这个特定的包没有),citation(package="sp")
0赞 Tomas 2/14/2014
@hadley似乎与(顺便说一句,在包装上不起作用,尝试另一个)?spsp
1赞 Frank 1/10/2017
不鼓励使用外部链接,因为它们有时会被买断和破坏,就像这里一样。就我个人而言,我几乎总是只是编写代码供读者输入他们的 R 会话,而不是提供链接。?args
13赞 Bryan Hanson 3/8/2013 #2

这个答案已经给了你一个非常全面的清单。

我要补充一点,如果你对你正在寻找的东西只有一个想法/关键词,并且还没有一个包或功能,那么包中的findFn(“一些搜索词”)是非常有帮助的。sos

还有 CRAN 上的任务视图:不是一个真正的搜索过程,而是一个在你想知道时徘徊的好地方。

2赞 gung - Reinstate Monica 3/1/2015 #3

这个线程包含许多好的建议。让我再补充一点。

对于查找加载了哪些包以及额外的好东西,?sessionInfo 非常好。

1赞 James Hirschorn 7/11/2016 #4

help(package="<package-name>")其中当然是您需要帮助的软件包的名称。<package-name>

1赞 Mrnufnuf 5/29/2017 #5

通常,多个包使用相同的函数名称。若要从特定包中获取有关函数的帮助,请使用:

help(aggregate, package="stats")
help(aggregate, package="sp")
1赞 andschar 8/25/2021 #6

RStudio IDE 中,可以单击任何函数名称并按 ,这将直接在其窗格中打开关联的函数帮助文本。就像你会打电话或.F1help()?fun()