Skip to content
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

Get GenVisR vigette to work with the vignette() function #171

Closed
malachig opened this issue Dec 8, 2015 · 1 comment
Closed

Get GenVisR vigette to work with the vignette() function #171

malachig opened this issue Dec 8, 2015 · 1 comment

Comments

@malachig
Copy link
Member

malachig commented Dec 8, 2015

It should be possible to get the GenVisR vignette to show in the list of available vignettes when one does vignette() in an R session after loading the GenVisR library.

Then this will open the PDF:
vignette("GenVisR")

@zlskidmore
Copy link
Member

I looked into this a little further, the following steps will solve this issue:

  1. build source package (can be done via rstudio or devtools::build())
  2. install source package (R CMD INSTALL GenVisR.tar.gz)

This will create a doc folder in the install location, running this will then display the vignette:
vignette("GenVisR_intro")

For some reason it appears that Rstudio/devtools does not create the doc folder automatically (there is probably a parameter somewhere). It does appear when installing from source.

Leaving this open for now while I verify and to remind myself that the vignette should probably be renamed from GenVisR_intro to GenvisR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants