r - 将 R 包函数索引打印到控制台

Question

我想将 R 包的文档打印到控制台。正在做

utils:::.getHelpFile(help("print"))

工作得很好，但是当我尝试时

utils:::.getHelpFile(help(package="MASS"))

我收到一条错误消息:

Error in dirname(file) : a character vector argument expected

所以我的问题是:如何将 R 包的文档(即 help(package="package_name"))打印到控制台？提前致谢。

Answer 1

help(package = "MASS") 将您带到 MASS 包的 INDEX 文件，该文件在浏览器窗口中打开(取决于根据您的设置)。要将文件读入控制台，我们可以使用 system.file() 获取文件路径，然后使用 readLines() 将其读取为字符向量。

## get the complete file path for the index file of the MASS package
f <- system.file("INDEX", package = "MASS")
## read it
readLines(f)
# [1] "Functions:"                                  
# [2] "========="
# [3] ""
# [4] "Null                    Null Spaces of Matrices"
# [5] "addterm                 Try All One-Term Additions to a Model"
# [6] "anova.negbin            Likelihood Ratio Tests for Negative Binomial GLMs"
# ...
# ...

或者我们可以将其包装在 cat() 中以获得更清晰的版本

cat(readLines(f), sep = "\n")
# Functions:
# =========
#
# Null                    Null Spaces of Matrices
# addterm                 Try All One-Term Additions to a Model
# anova.negbin            Likelihood Ratio Tests for Negative Binomial GLMs
# ...
# ...

或者，您也可以得到相同的结果

readLines(file.path(find.package("MASS"), "INDEX"))

最后，如果您想了解 html 浏览器顶部出现的软件包描述和新闻的链接，可以通过以下方式获取这些链接

packageDescription("MASS")
news(package = "MASS")