New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

install_github() doesn't build vignette PDFs & local=FALSE doesn't work either #344

Closed
rpruim opened this Issue Sep 5, 2013 · 7 comments

Comments

Projects
None yet
3 participants
@rpruim

rpruim commented Sep 5, 2013

The new default behavior of install_github() doesn't build the PDFs from Rnw files in the vignettes directory.

Setting local=FALSE fails, presumably because local slipped out of ... somewhere between install_github() and install():

> install_github('devtools',local=FALSE)
Installing github repo(s) devtools/master from hadley
Downloading devtools.zip from https://github.com/hadley/devtools/archive/master.zip
Installing package from /var/folders/qm/fvhzvrvx1qs1cr8c0pkk5f9m0000gn/T//RtmpRMuUAQ/devtools.zip
Error in install(pkg_path, local = TRUE, quiet = quiet, ...) : 
  formal argument "local" matched by multiple actual arguments

Downloading from github and using install() directly with local=FALSE does work.

@rpruim

This comment has been minimized.

rpruim commented Sep 5, 2013

I think the culprit is the last line of install_local_single()

install(pkg_path, local = TRUE, quiet = quiet, ...)
@krlmlr

This comment has been minimized.

Member

krlmlr commented Sep 6, 2013

Hasn't this been fixed in #328? Could you try installing the most recent version of devtools from GitHub?

@rpruim

This comment has been minimized.

rpruim commented Sep 6, 2013

It looks like you are right about local=FALSE working correctly with an updated devtools. Sorry about that. But I still think that vignettes should be built by default rather than requiring an option to be set.

@hadley hadley closed this in 9a7253b Oct 7, 2013

@hadley

This comment has been minimized.

Member

hadley commented Oct 9, 2013

Hmmm, actually there's a bit of a recursion problem here - to build the vignettes you usually need to have install the package first. So it might be better to install the package, then build the vingnettes, then reinstall. Not sure how R CMD build gets around this.

@hadley hadley reopened this Oct 9, 2013

@rpruim

This comment has been minimized.

rpruim commented Oct 9, 2013

I wonder if when you figure this out it will answer another question I have: Is it possible to create a vignette (Rnw -> PDF) that has links to files that will be installed with the package (in inst/PDF, for example)?

@hadley

This comment has been minimized.

Member

hadley commented Oct 10, 2013

@rpruim probably not :( My sense is that CRAN is getting increasingly hostile to any additional documentation not generated by the vignette process. What additional files are you trying to include?

@rpruim

This comment has been minimized.

rpruim commented Oct 10, 2013

PDFs created using Rnw files but also including lots of additional images and using resampling, so they are slow to generate. I don't want to regenerate them every time I check the package :( Furthermore, the files use some custom style files. So it seems simpler just to get the PDF compiled and provide it as a done deal.

My current solution is to put the PDFs in inst/PDFS and then put a real vignette with links to these on github (even though the files are actually also inside the package).

I suppose the other option would be to include them as additional documentation that isn't a vignette, but then they don't show up when searching for vignettes.

@hadley hadley closed this in 631f4b1 Oct 11, 2013

@lock lock bot locked and limited conversation to collaborators Sep 19, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.