[R-pkg-devel] Vignette does not show up after loading package

Duncan Murdoch murdoch.duncan at gmail.com
Wed Jun 3 18:41:18 CEST 2015


On 03/06/2015 12:16 PM, Rik Verdonck wrote:
> Hi all,
> 
> 
> 
> 
> I am developing a package for the interpretation of mass spectrometry data, which can be found here: https://github.com/goat-anti-rabbit/labelpepmatch.R

If your vignette is not written in Sweave, you need to tell R what
package handles it.  See the "Non-Sweave vignettes" section 1.4.2 in
Writing R Extensions.

Duncan Murdoch

> I wrote a vignette that compiles fine into a .html using knitr in Rstudio.
> The output line in the vignette.rmd file looks like :
> 
> ??output: rmarkdown::html_vignette
> 
> However, when I use devtools::install_github("goat-anti-rabbit/labelpepmatch.R") or devtools::install_github("goat-anti-rabbit/labelpepmatch.R",build_vignettes = TRUE), the package loads normally, but no vignette is found when using browseVignettes("labelpepmatch") or vignette("labelpepmatch").
> 
> I don't really get this, because as far as I understood, shouldn't the package be able to build the vignette from scratch?
> 
> I also tried with these lines for output:
> 
> output:
>   html_document:
>     theme: readable
>   pdf_document:
>     highlight: default
>     toc: yes
> 
> And it nicely knits into example html and pdf files, but no real files are created in the labelpepmatch/vignettes directory. Any suggestions here?
> 
> 
> So: recap of my questions:
> 1. Should it be possible for the vignette to be built from scratch and if yes, what is missing in my package for this functionality to work?
> 2. How can I make knitr output a html AND pdf in my vignettes directory?
> 
> Looking forward to your replies.
> Many, many thanks!
> Rik
> 
> 
> 
> 	[[alternative HTML version deleted]]
> 
> ______________________________________________
> R-package-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>



More information about the R-package-devel mailing list