browseVignettes出错:找不到晕影

时间:2018-03-25 14:15:41

标签: r rstudio r-package

我正在尝试查看我在本地计算机上重建软件包后创建的小插图。请注意,这与this帖子上的建议无关,因为我不是从Github克隆的。

我的插图文件的插图部分如下所示:

vignette: >
  %\VignetteIndexEntry{pack_name}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}

过程是:

  1. Ctr + Shift + K编织小插图

  2. Ctr + Shift + B重建包

  3. 输入browseVignettes("package name")

  4. 获取错误: No vignettes found by browseVignettes

    我也尝试将knitr::markdown更改为knitr::knitr,但没有帮助。

    整个小插图顶部:

    ---
    title: "Random title"
    author: "Author"
    date: "`r Sys.Date()`"
    output: rmarkdown::html_vignette
    vignette: >
      %\VignetteIndexEntry{vignette_name}
      %\VignetteEngine{knitr::rmarkdown}
      %\VignetteEncoding{UTF-8}
    ---
    

1 个答案:

答案 0 :(得分:4)

你没有提供所有细节来说明出了什么问题,但这是你需要做的事情:

  1. Vignettes需要位于包vignettes目录中。
  2. 如果它们不是Sweave的小插曲(你的是knitr :: rmarkdown,根据你向我们展示的标题行),那么你需要在描述文件中告诉R它。以您为例,您需要 VignetteBuilder: knitr 在该文件中,knitrSuggestsDepends行中列出了Imports
  3. 您需要遵循晕影引擎的命名约定。对于knitr :: rmarkdown,将文件命名为something.Rmd
  4. 您不需要自己编织文件。 R将在构建源包时执行此操作。 (您可以配置RStudio为"安装并重新启动";默认情况下它不会。)即使您没有编织小插图,browseVignettes也应该找到它如果你已经正确地遵循了其他步骤,它就不会显示HTML或PDF输出,只显示源和提取的R代码。
  5. 编辑添加:构建并重新安装软件包时,除非安装是从.tar.gz文件完成的,否则有时候不会包含小插图。使用"构建源包" RStudio构建窗格中的选项可以获取其中一个。