R hsearch-utils 帮助搜索实用程序

说明

用于搜索帮助系统的实用程序。

用法

hsearch_db(package = NULL, lib.loc = NULL,
           types = getOption("help.search.types"), 
           verbose = getOption("verbose"),
           rebuild = FALSE, use_UTF8 = FALSE)
hsearch_db_concepts(db = hsearch_db())
hsearch_db_keywords(db = hsearch_db())

参数

package	包含要搜索的包名称的字符向量，或 NULL，在这种情况下，将搜索 lib.loc 指定的库树中的所有可用包。
lib.loc	说明位置的字符向量R要搜索的库树，或者NULL.默认值为NULL对应于当前已知的所有库。
types	列出要搜索的文档类型的字符向量。有关详细信息，请参阅help.search。
verbose	控制构建帮助搜索数据库的详细程度的逻辑。有关详细信息，请参阅help.search。
rebuild	指示是否应重建帮助搜索数据库的逻辑。有关详细信息，请参阅help.search。
use_UTF8	逻辑：结果应该以 UTF-8 编码给出吗？
db	通过调用 hsearch_db() 获得的帮助搜索数据库。

细节

hsearch_db() 构建并缓存帮助搜索数据库以供 help.search 后续使用。 (事实上，仅在强制(rebuild = TRUE)或“necessary”时重新构建。)

帮助搜索数据库的格式仍处于实验阶段，在未来版本中可能会发生变化。目前，它由四个表组成：一个表包含有关找到的所有文档对象的基本信息，包括它们的名称、标题和唯一 ID；另外三个表包含各个别名、概念和关键字以及它们所属的文档对象的 ID。分离后三个表说明了单个文档对象可以提供其中多个条目的事实，并允许有效的搜索。

有关如何根据帮助类型解释可搜索条目的详细信息，请参阅help.search 中的详细信息。

hsearch_db_concepts() 和 hsearch_db_keywords() 分别从帮助搜索数据库中提取所有概念或关键字，并将它们连同它们的总频率和它们所使用的包的数量一起返回到 DataFrame 中，条目按总频率递减排序。

例子

db <- hsearch_db()
## Total numbers of documentation objects, aliases, keywords and
## concepts (using the current format):
sapply(db, NROW)
## Can also be obtained from print method:
db
## 10 most frequent concepts:
head(hsearch_db_concepts(), 10)
## 10 most frequent keywords:
head(hsearch_db_keywords(), 10)