建立小插曲

小插圖是你的包裝的長篇指南。如果你知道你需要的功能的名稱,功能文件是很好的,但是否則它是無用的。小插圖就像書章或學術論文:它可以描述你的包裝設計要解決的問題,然後向讀者展示如何解決它。

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 中列為依賴項。