创建小插曲
小插图是你的包装的长篇指南。如果你知道你需要的功能的名称,功能文档是很好的,但是否则它是无用的。小插图就像书章或学术论文:它可以描述你的包装设计要解决的问题,然后向读者展示如何解决它。
Vignettes 将完全以降价方式创建。
要求
- Rmarkdown:
install.packages("rmarkdown")
- Pandoc
小插图创作
devtools::use_vignette("MyVignette", "MyPackage")
你现在可以在 ./vignettes/MyVignette.Rmd
编辑你的插图。
插图中的文字格式为 Markdown 。
原始 Markdown 的唯一补充是一个标记,它接受 R 代码,运行它,捕获输出,并将其转换为格式化 Markdown:
```{r}
## Add two numbers together
add <- function(a, b) a + b
add(10, 20)
```
将显示为:
# Add two numbers together
add <- function(a, b) a + b
add(10, 20)
## [1] 30
因此,你在渐晕中使用的所有包都必须在 ./DESCRIPTION
中列为依赖项。