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