buildVignette
位于 tools
包(package)。 说明
在一个小插图上运行 Sweave
(或其他自定义编织函数)、 texi2pdf
和/或 Stangle
(或其他自定义缠结函数)。
这是 R CMD Sweave
的主力。
用法
buildVignette(file, dir = ".", weave = TRUE, latex = TRUE, tangle = TRUE,
quiet = TRUE, clean = TRUE, keep = character(),
engine = NULL, buildPkg = NULL, encoding, ...)
参数
file |
特点;小插图源文件。 |
dir |
特点;将在其中生成中间文件和输出文件的工作目录。 |
weave |
逻辑性;应该运行编织吗? |
latex |
逻辑性;应该tools texi2dvi如果编织产生‘.tex' 文件? |
tangle |
逻辑性;应该运行缠结吗? |
quiet |
逻辑性;以安静模式运行? |
clean |
逻辑性;是否删除一些新创建的(通常是中间的)文件。请参阅下面的详细信息。 |
keep |
清理时无论如何都要保留的文件名列表。请注意,“target” 文件无论如何都会保留。 |
engine |
|
buildPkg |
|
encoding |
文件的编码。如果未指定,则尽可能从文件内容中读取。请注意,如果插图是包的一部分, |
... |
传递给 weave 和 tangle 的附加参数。 |
细节
该函数确定晕影的晕影引擎(默认utils::Sweave
),然后使用该引擎编织和/或缠结小插图。最后,如果clean
是TRUE
,新创建的中间文件(非“targets”,这些文件取决于引擎等,而不是任何keep
)将被删除。如果clean
是NA
, 和weave
为 true,则新创建的中间输出文件(例如,‘.tex’) 即使‘.pdf’ 文件已由它们生成。
如果buildPkg
指定后,这些包将在处理 vignette 之前加载,并将用作搜索 vignette 引擎的默认包,但在 vignette 源中明确指定的包(例如,使用‘\VignetteEngine{utils::Sweave}’来指定Sweave
发动机在utils
包)将覆盖它。相反,如果engine
给出参数,它将覆盖晕影源。
值
命名已生成的文件的字符向量。
作者
Henrik Bengtsson and Duncan Murdoch
也可以看看
buildVignettes
用于构建包中的所有小插图。
相关用法
- R buildVignettes 列出并构建包插图
- R bibstyle 选择或定义参考书目样式
- R update_PACKAGES 更新现有的 PACKAGES 文件
- R print.via.format 打印实用程序
- R prepare_Rd 准备用于渲染的解析 Rd 对象
- R startDynamicHelp 启动动态 HTML 帮助系统
- R getVignetteInfo 获取有关已安装 Vignettes 的信息
- R matchConcordance 源行和目标行之间的一致性
- R checkVignettes 检查包装插图
- R Rd2HTML 路转换器
- R HTMLheader 为 R 帮助生成标准 HTML 标头
- R undoc 查找未记录的对象
- R vignetteInfo 有关晕影的基本信息
- R HTMLlinks 从包文档收集 HTML 链接
- R xgettext 从包中的 R 文件中提取可翻译消息
- R toTitleCase 将标题转换为标题大小写
- R package_native_routine_registration_skeleton 编写用于将本机例程注册添加到包的框架
- R parse_Rd 解析 Rd 文件
- R update_pkg_po 准备包的翻译
- R vignetteEngine 设置或获取晕影处理引擎
- R Rcmd R命令接口
- R Rdindex 从 Rd 文件生成索引
- R checkMD5sums 检查并创建 MD5 校验和文件
- R checkFF 检查外部函数调用
- R package_dependencies 包的依赖层次结构的计算
注:本文由纯净天空筛选整理自R-devel大神的英文原创作品 Build One Vignette。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。