browseVignettes找不到实际存在的晕影

时间:2015-08-23 21:47:59

标签: r devtools

我在obj2.prop=2目录中有package on a github repository个2个小插图。

我尝试使用vignettes/这样的

包下载
devtools

但是当我尝试浏览Vignettes时,看来它们不是构建的。

> if (!require(devtools)) {
+     install.packages("devtools")
+     require(devtools)
+ }
> install_github("MarcinKosinski/RTCGA", build_vignettes=TRUE)
Downloading github repo MarcinKosinski/RTCGA@master
Installing RTCGA
"D:/R-32~1.2/bin/x64/R" --no-site-file --no-environ --no-save --no-restore CMD INSTALL  \
  "C:/Users/Marcin/AppData/Local/Temp/Rtmpg1Kbfy/devtools3cf47f1f6731/MarcinKosinski-RTCGA-0d91d7c"  \
  --library="C:/Users/Marcin/Documents/R/win-library/3.2" --install-tests 

* installing *source* package 'RTCGA' ...
** R
** tests
** preparing package for lazy loading
** help
*** installing help indices
** building package indices
** installing vignettes
** testing if installed package can be loaded
* DONE (RTCGA)
Reloading installed RTCGA
Welcome to the RTCGA (version: 0.99.6).

我已经看到some old issue人们建议使用> library(RTCGA) > browseVignettes("RTCGA") No vignettes found by browseVignettes("RTCGA") ,但正如您所见,它没有帮助添加移动Vignettes以移除来自build_vignettes=TRUE文件的inst/doc/目录。但这一定是老问题,因为在安装软件包之后我还没有在二进制源中看到这样的目录。

我也在类似的问题上看到this answer,但是当我构建源代码然后从源代码安装软件包时,它似乎有同样的问题:.Rbuildignore

关于如何使这项工作的任何想法?

修改

根据马丁的回答 我已经将这段代码添加到了小插曲中。 YAML

No vignettes found by browseVignettes("RTCGA")

我编辑了我的2个小插曲的YAML

  • 我已经为YAML的开头添加了代码 - this file
  • 以防我曾在YAML结尾添加新信息 - this file

但是从github安装后仍然没有可用的晕影

vignette: >
  %\VignetteIndexEntry{Integrating TCGA Data - RTCGA Tutorial}
  %\VignetteEngine{knitr::rmarkdown}

编辑2

当然我已经忘记添加参数 > devtools::install_github("MarcinKosinski/RTCGA") Downloading github repo MarcinKosinski/RTCGA@master Installing RTCGA '/usr/lib/R/bin/R' --vanilla CMD INSTALL \ '/tmp/Rtmpk34Zbr/devtools531845716f54/MarcinKosinski-RTCGA-5571117' \ --library='/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.2' --install-tests * installing *source* package ‘RTCGA’ ... ** R ** tests ** preparing package for lazy loading ** help *** installing help indices ** building package indices ** installing vignettes ** testing if installed package can be loaded * DONE (RTCGA) > library(RTCGA) Welcome to the RTCGA (version: 0.99.6). > browseVignettes("RTCGA") No vignettes found by browseVignettes("RTCGA") 但是在此之后看起来看起来像是晕影但是在构建期间他们的编译存在一些问题:

buildVignettes = TRUE

2 个答案:

答案 0 :(得分:7)

从编写R扩展程序,1.4.2部分,您的插图需要有一行

%\VignetteEngine{knitr::knitr}

在他们中间;一个常见的范例是将以下内容添加到小插图顶部的yaml

vignette: >
  %\VignetteIndexEntry{Integrating TCGA Data}
  %\VignetteEngine{knitr::rmarkdown}

VignetteIndexEntry为R的帮助系统提供了方便的标题。请记住BiocStyle包,用于创建具有一致外观的晕影。

答案 1 :(得分:0)

我只能使用以下方法解决此问题:

devtools::build_vignettes()

当然,然后通过git上传新文件