用途:为 R 包编写面向用户的 vignette 长文档,例如“Getting Started”教程、跨多个函数的复杂工作流说明、特定领域指南,以及满足 CRAN 提交所需的函数帮助之外的用户文档。
主要能力:使用 usethis::use_vignette() 生成 vignette 文件与目录结构;配置 YAML 前端(title、output、vignette 三项 %\Vignette* 条目);通过代码块选项控制求值、显示与图形尺寸;条件加载可选依赖、用预计算 .rds 处理高耗时计算;用 devtools::build_vignettes() 构建、devtools::check() 验证。
必要用法:在包根目录(含 DESCRIPTION)运行 usethis::use_vignette("getting-started", title = "Getting Started with packagename");在 setup 块中用 include=FALSE 设置 knitr::opts_chunk$set();示例用 library(packagename) 而非 devtools::load_all();外部 API 或需密钥代码用 eval=FALSE。
适用场景:CRAN 提交前的用户文档补充、pkgdown 文章、统计方法或复杂流程说明。限制与注意:VignetteIndexEntry 须与标题一致,三条 %\Vignette* 行缺一不可;构建时间需控制在 CRAN 限制内(通常 60 秒内),过慢可预计算或用 eval=FALSE;需 pandoc,必要时设置 RSTUDIO_PANDOC;缺少 Suggests 包或包未安装会导致构建失败。
未提供的信息:本资料未说明该技能的安装命令、依赖版本、收费方式或具体平台限制。