Nie znaleziono winiet przez browseVignettes, gdzie one faktycznie są

Question

Mam package on a github repository z 2 winietami w katalogu vignettes/.

Próbowałem ściągnąć z devtools jeśli pakiet jak ten

> 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). 

ale gdy próbuję przeglądać winiet wydaje się ich nie budować.

> library(RTCGA) 
> browseVignettes("RTCGA") 
No vignettes found by browseVignettes("RTCGA") 

Widziałem some old issue gdzie ludzie zalecane, aby użyć build_vignettes=TRUE, ale jak widać to nie pomogło LUB dodać winiet przejść do usunięcia inst/doc/ katalog z .Rbuildignore pliku. Ale to musi być i stary problem, ponieważ nie widziałem takiego katalogu w źródle binarnym po instalacji pakietu.

Widziałem również this answer na podobnym pytaniu, ale kiedy zbudowałem źródło, a następnie zainstalowałem pakiet ze źródła, wydaje się, że ma ten sam problem: No vignettes found by browseVignettes("RTCGA").

Każdy pomysł, jak to zrobić?

EDIT

Według Marcina odpowiedź mam addedthis fragment kodu do YAML winiet

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

Mam edytowanej YAML z 2 moich winiet

• Dodałem kod na początku YAML - this file
• wszelki wypadek kiedyś dodano nowe informacje do końca YAML - this file

ale nadal pojawia się brak winiety dostępne po instalacji z github

> 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") 

EDIT 2

Oczywiście zapomniałem dodać parametru buildVignettes = TRUE, ale po tym wygląda na winiety, ale są pewne problemy z kompilacją podczas kompilacji:

devtools::install_github("MarcinKosinski/RTCGA", build_vignettes=TRUE) 
Downloading github repo MarcinKosinski/RTCGA@master 
Installing RTCGA 
'/usr/lib/R/bin/R' --vanilla CMD build \ 
    '/tmp/RtmpA7il1Q/devtools5fc871b48f57/MarcinKosinski-RTCGA-e47bdf6' \ 
    --no-resave-data --no-manual 

* checking for file ‘/tmp/RtmpA7il1Q/devtools5fc871b48f57/MarcinKosinski-RTCGA-e47bdf6/DESCRIPTION’ ... OK 
* preparing ‘RTCGA’: 
* checking DESCRIPTION meta-information ... OK 
* installing the package to build vignettes 
* creating vignettes ... OK 
* checking for LF line-endings in source and make files 
* checking for empty or unneeded directories 
Removed empty directory ‘RTCGA/ghPage’ 
Removed empty directory ‘RTCGA/inst’ 
* building ‘RTCGA_0.99.6.tar.gz’ 

'/usr/lib/R/bin/R' --vanilla CMD INSTALL \ 
    '/tmp/RtmpA7il1Q/RTCGA_0.99.6.tar.gz' \ 
    --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 
Warning in file(con, "w") : 
    cannot open file '/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.2/RTCGA/doc/index.html': No such file or directory 
Error in file(con, "w") : cannot open the connection 
ERROR: installing vignettes failed 
* removing ‘/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.2/RTCGA’ 
* restoring previous ‘/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.2/RTCGA’ 
Error: Command failed (1) 

Answer 1

od pisania R Extensions sekcji 1.4.2 Twoje winiet muszą mieć linię

%\VignetteEngine{knitr::knitr} 

w nich; wspólny paradygmat dodanie następujących do YAML na górze winieta

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

VignetteIndexEntry dostarcza dogodnego tytuł systemu pomocy R'S. Zapamiętaj pakiet BiocStyle do tworzenia winiet o jednolitym wyglądzie.