R checkVignettes 检查包装插图

说明

通过在包上运行Sweave(或其他自定义编织函数)和/或Stangle(或其他自定义缠结函数)来检查包的所有小插图。在缠结步骤之后找到的所有 R 源代码文件都经过 source 编辑，以检查所有代码是否可以无错误地执行。

用法

checkVignettes(package, dir, lib.loc = NULL,
               tangle = TRUE, weave = TRUE, latex = FALSE,
               workdir = c("tmp", "src", "cur"),
               keepfiles = FALSE)

参数

package	命名已安装包的字符串。如果给定，则在子目录‘中查找晕影源文件文档’。
dir	指定包根源目录路径的字符串。如果给定，则在子目录‘中查找晕影源文件小插图’。
lib.loc	目录名称的字符向量R Library ，或NULL.默认值为NULL对应于当前已知的所有库。指定的库树用于搜索package.
tangle	与source提取的代码进行纠缠？
weave	进行编织？
latex	逻辑：如果weave和latex是TRUE并且没有‘生成文件' 在vignettes目录中，运行中间'.tex' 编织的输出texi2pdf.
workdir	检查小插图时用作工作目录的目录。如果"tmp"然后创建一个临时目录，这是默认的。如果"src"然后使用包含小插图本身的目录，如果"cur"那么当前的工作目录R被使用。

keepfiles

删除临时目录中的文件？当 workdir != "tmp" 时，此选项将被忽略。

细节

此函数首先使用 pkgVignettes 查找包小插图，特别是它们的小插图引擎(请参阅 vignetteEngine )。

如果tangle为 true，然后运行Stangle(或引擎提供的其他自定义缠结函数)来生成(一个或多个)R每个小插图中的代码文件，然后source依次读取每个代码文件。

如果weave是真的，这些小插曲都贯穿了Sweave(或引擎提供的其他自定义编织函数)。如果latex也是如此，并且不存在‘生成文件' 在小插图目录中，texi2pdf在中间运行'.tex' 来自编织的那些在前面的步骤中没有给出错误的小插图的文件。

值

"checkVignettes" 类的对象，它是一个列表，其中包含在缠结、源、编织和乳胶步骤期间发现的错误消息。有一个 print 方法用于显示此类对象中包含的信息。