R aspell-utils 拚寫檢查實用程序

說明

通過 Aspell、Hunspell 或 Ispell 對包進行拚寫檢查的實用程序。

用法

aspell_package_Rd_files(dir, drop = c("\\author", "\\references"),
                        control = list(), program = NULL,
                        dictionaries = character())
aspell_package_vignettes(dir,
                         control = list(), program = NULL,
                         dictionaries = character())
aspell_package_R_files(dir, ignore = character(), control = list(),
                       program = NULL, dictionaries = character())
aspell_package_C_files(dir, ignore = character(), control = list(),
                       program = NULL, dictionaries = character())

aspell_write_personal_dictionary_file(x, out, language = "en",
                                      program = NULL)

參數

dir	指定包根目錄路徑的字符串。
drop	一個字符向量，命名通過 RdTextFilter 選擇文本時要刪除的附加 Rd 部分。
control	拚寫檢查器的控製選項的列表或字符向量。
program	給出要使用的拚寫檢查程序的名稱(如果在係統路徑上)或完整路徑的字符串，或NULL(默認)。默認情況下，係統路徑會搜索 aspell 、 hunspell 和 ispell (按順序)，並使用找到的第一個。
dictionaries	要使用的其他 R 級別字典的名稱或文件路徑的字符向量。請參閱aspell。
ignore	帶有正則表達式的字符向量，在過濾消息字符串時用空格替換。
x	字符向量，或調用 aspell() 的結果。
out	命名要寫入的個人詞典文件的字符串。
language	指示 Aspell 使用的語言的字符串。

細節

函數 aspell_package_Rd_files 、 aspell_package_vignettes 、 aspell_package_R_files 和 aspell_package_C_files 對根目錄 dir 包的 Rd 文件、插圖、R 文件和 C-level 消息執行拚寫檢查。他們確定相應的文件，應用適當的過濾器，並運行拚寫檢查器。

有關過濾器的詳細信息，請參閱aspell。

C-level 消息字符串是從‘寶/PACKAGE。鍋' 消息目錄文件，其中PACKAGE的基本名稱dir。有關詳細信息，請參閱“編寫 R 擴展”中的“C-level 消息”部分。

使用 Aspell 時，插圖檢查會跳過命令 ⁠\Sexpr⁠ 、 ⁠\citep⁠ 、 ⁠\code⁠ 、 ⁠\pkg⁠ 、 ⁠\proglang⁠ 和 ⁠\samp⁠ 的參數和/或選項。通過將 ⁠--add-tex-command⁠ 選項添加到 control 參數，可以跳過更多命令。例如，要跳過 ⁠\mycmd⁠ 的選項和參數，請添加 ⁠--add-tex-command='mycmd op'⁠ 。

適合的值control,program,dictionaries,drop和ignore也可以使用包默認文件來指定，該文件應為“defaults.R' 進入 '.aspell’的子目錄dir，並通過分配合適的命名列表來提供默認值，例如，

vignettes <- list(control = "--add-tex-command='mycmd op'")

對於小插圖(使用 Aspell 時)，並類似地為 Rd 文件、R 文件和 C 級消息默認值分配給 Rd_files 、 R_files 和 C_files 。

使用英語和美式拚寫的軟件包的維護者會發現傳遞控製選項很方便--master=en_US和--add-extra-dicts=en_GBAspell 和控製選項-d en_US,en_GB到Hunspell(前提是安裝了相應的詞典)。

舊版本的R不支持 R 級字典，因此提供了該函數aspell_write_personal_dictionary_file根據要接受的單詞創建(拚寫檢查)program-specific 個人詞典文件。新機製是使用 R 級字典，即‘.rds’通過使用序列化這些單詞的字符向量獲得的文件saveRDS。對於通過包默認機製指定的此類字典，沒有路徑分隔符的元素可以是 R 係統字典或“.aspell’子目錄。

也可以看看

aspell