[R-pkg-devel] Issue with including vignettes without building package

Zhian Kamvar kamvarz at science.oregonstate.edu
Thu Apr 20 22:39:05 CEST 2017


Perhaps you could add a Makefile with a rule that compiles the vignettes into the inst/doc directory? This might avoid the build process.

-----
Zhian N. Kamvar, Ph. D.
Postdoctoral Researcher (Everhart Lab)
Department of Plant Pathology
University of Nebraska-Lincoln



> On Apr 20, 2017, at 15:30 , Alexandre Courtiol <alexandre.courtiol at gmail.com> wrote:
> 
> Thanks but I don't think so, that would imply them to rebuild the
> vignettes, which is exactly what I want to avoid.
> Without knitr cached chunk it would take forever on their laptops and they
> would also need to install tons of packages...
> ++
> 
> On 20 April 2017 at 21:01, Sven E Templer <sven.templer at gmail.com <mailto:sven.templer at gmail.com>> wrote:
> 
>> Hi Alex,
>> 
>> 
>> what if you run
>> 
>> devtools::install_github(build_vignettes = TRUE)
>> 
>> on your students computer?
>> 
>> See ?devtools::install
>> 
>> 
>> Best,
>> 
>> Sven
>> 
>> 
>>> On 20. Apr 2017, at 15:09, Alexandre Courtiol <
>> alexandre.courtiol at gmail.com> wrote:
>>> 
>>> Dear all,
>>> 
>>> I am using a package for teaching:
>>> my slides are html vignettes, and it is convenient for students to
>> control
>>> which packages they must install, provide code and datasets.
>>> 
>>> As I am often editing the package live during the course, it would be
>> great
>>> if I could just push to github and that the student would just have to
>> run
>>> a devtools::install_github() to get my updated vignettes. I would rather
>>> not to have to build the package before pushing to save time.
>>> 
>>> The issues is that I do not want to build the vignettes on install as
>> they
>>> are very slow to build. On my computer however it is quick because I have
>>> cached the knitr chunks output. So I was hoping to just have to run
>>> devtools::build_vignettes() on my machine before pushing the files
>> thereby
>>> created (./inst/doc) and that the student could just
>>> devtools::install_github().
>>> 
>>> I cannot make this work: no vignettes are found after install. When I do
>>> check the repository beeing installed on their computers, the html, Rmd
>> and
>>> R files corresponding to the vignettes are present in ./doc, so it is not
>>> an issue of having the wrong .gitgnore configuration.
>>> 
>>> I have read about many vignettes related issues on the net, but I did not
>>> find something dealing with this precise issue.
>>> 
>>> PS: I know about the R.rsp hack, but I would prefer to find a solution
>> more
>>> direct.
>>> 
>>> Best,
>>> 
>>> Alex
>>> 
>>> 
>>> 
>>> 
>>> --
>>> Alexandre Courtiol
>>> 
>>> http://sites.google.com/site/alexandrecourtiol/home
>>> 
>>> *"Science is the belief in the ignorance of experts"*, R. Feynman
>>> 
>>>      [[alternative HTML version deleted]]
>>> 
>>> ______________________________________________
>>> R-package-devel at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>> 
>> 
> 
> 
> -- 
> Alexandre Courtiol
> 
> http://sites.google.com/site/alexandrecourtiol/home <http://sites.google.com/site/alexandrecourtiol/home>
> 
> *"Science is the belief in the ignorance of experts"*, R. Feynman
> 
> 	[[alternative HTML version deleted]]
> 
> ______________________________________________
> R-package-devel at r-project.org <mailto:R-package-devel at r-project.org> mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel <https://stat.ethz.ch/mailman/listinfo/r-package-devel>

	[[alternative HTML version deleted]]



More information about the R-package-devel mailing list