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)