【问题标题】:How to get help in R?如何在 R 中获得帮助?
【发布时间】:2013-03-08 08:49:40
【问题描述】:

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

除了help(sp),还有哪些帮助和文档搜索功能?

【问题讨论】:

  • 该软件包最直接的帮助来自help(pac=sp),它应该会打开索引页面。

标签: r r-faq


【解决方案1】:

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

使用? 或等效的help

?mean
help(mean) # same

对于非标准名称,请使用quotes 或反引号;见An Introduction to R: Getting help with functions and features:

对于特殊字符指定的特征,参数必须用双引号或单引号括起来,使其成为“字符串”:这对于包括ifforfunction。”

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

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

?iris
?Syntax
?lubridate    

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

example(paste)
example(`for`)

demo 函数给出了如何使用函数的更长时间的演示。

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 plugin 的R 搜索引擎。

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

sos 中的findFn 包装 RSiteSearch 以 HTML 表格形式返回结果。

RSiteSearch("logistic regression")

library(sos)
findFn("logistic regression")

查找包

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

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

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

data()

search 告诉你哪些包已经加载。

search()

packageDescription 显示包的DESCRIPTION 文件的内容。同样news 读取NEWS 文件。

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 的一般学习

Info page 是一组非常全面的免费 R 资源链接。

R 中的许多主题都通过vignettes 记录,并以browseVignettes 列出。

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

通过组合vignetteedit,您可以在编辑器中获取其代码块。

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

【讨论】:

  • news(package="sp")(对于这个特定的包没有),citation(package="sp")
  • @hadley 似乎与?sp 相同(顺便说一句,不适用于包sp,请尝试另一个)
  • 不鼓励使用外部链接,因为它们有时会被买断和损坏,就像这里一样。就个人而言,我几乎总是将?args 写成代码,供读者在他们的 R 会话中输入,而不是提供链接。
【解决方案2】:

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

【讨论】:

    【解决方案3】:

    This answer 已经为您提供了一个非常全面的列表。

    我要补充一点,sos 包中的findFn("some search terms") 非常有帮助,如果您对正在寻找的内容只有一个想法/关键字,并且还没有考虑到包或功能。

    还有task views on CRAN:不是真正的搜索过程,而是一个随心所欲漫步的好地方。

    【讨论】:

      【解决方案4】:

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

      help(aggregate, package="stats")
      help(aggregate, package="sp")
      

      【讨论】:

        【解决方案5】:

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

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

        【讨论】:

          【解决方案6】:

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

          【讨论】:

            猜你喜欢
            • 2021-11-10
            • 2016-06-22
            • 1970-01-01
            • 2013-06-05
            • 1970-01-01
            • 1970-01-01
            • 1970-01-01
            • 1970-01-01
            相关资源
            最近更新 更多