Keine von browseVignettes gefunden Vignetten, wo sie sind tatsächlich dort

Question

Ich habe ein package on a github repository mit 2 Vignetten im vignettes/ Verzeichnis.

Ich habe versucht, wenn mit devtools Paketen wie diese

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

herunterladen, aber wenn ich versuche, Vignetten zu durchsuchen es scheint, dass sie nicht beim Aufbau wurden.

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

Ich habe some old issue gesehen, wo die Menschen build_vignettes=TRUE verwenden vorgeschlagen, aber wie Sie es sehen nicht helfen ODER bewegen Vignetten hinzuzufügen inst/doc/ Verzeichnis von .Rbuildignore Datei zu entfernen. Aber das muss ein altes Problem sein, weil ich ein solches Verzeichnis nach der Installation des Pakets nicht in einer Binärquelle gesehen habe.

Ich habe auch this answer auf eine ähnliche Frage gesehen, aber wenn ich Quelle erstellt und dann Paket von einer Quelle installieren, scheint es das gleiche Problem zu haben: No vignettes found by browseVignettes("RTCGA").

Irgendeine Idee, wie man das funktioniert?

EDIT

Laut Martin Antwort habe ich addedthis Codefragment Vignetten YAML

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

ich YAML von 2 meiner Vignetten

• bearbeitet haben ich habe Code beggining von YAML hinzugefügt - this file
• Nur für den Fall ich einmal neue Informationen zum Ende des YAML hinzugefügt - this file

aber immer noch scheint es keine Vignetten verfügbar nach der Installation von 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

natürlich habe ich Parameter buildVignettes = TRUE hinzufügen forgoten aber danach sieht es aus wie Vignetten zu sehen ist, aber es gibt ein Problem mit ihrer Zusammenstellung während Baujahr:

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

Von Writing R Extensions, Abschnitt 1.4.2, benötigen Vignetten

%\VignetteEngine{knitr::knitr} 

in ihnen eine Linie haben; ein gemeinsames Paradigma ist folgendes yaml an der Spitze der Vignette

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

VignetteIndexEntry bietet einen bequemen Titel für R Hilfesystem hinzuzufügen. Denken Sie an das -Paket zum Erstellen von Vignetten mit einem konsistenten Aussehen.