Home Comments Thread
New Thread

[knitr] Package vignettes: How to build package vignettes with knitr | /knitr/demo/vignette/

yihui yihui 2022-12-16 22:21:40

Package vignettes: How to build package vignettes with knitr

https://yihui.org/knitr/demo/vignette/

5 Comments

giscus-bot giscus-bot 2022-12-16 22:21:41
Guest *Ben Bolker* @ 2012-05-05 15:54:44 originally posted:

Any chance of bringing this up with R-core again?  Was your proposal ignored, or outright rejected?

yihui yihui 2022-12-16 22:21:45

I searched my inbox and this is a recent discussion (no R core showed up): https://stat.ethz.ch/pipermail/r-devel/2011-November/062469.html

We can certainly bring this up again, but I think I have a better plan, which I will show this summer.

Originally posted on 2012-05-06 01:30:39

yihui yihui 2022-12-16 22:21:46

As you have mentioned, R 3.0.0 will support non-Sweave vignettes, even including R Markdown vignettes :)

Originally posted on 2013-02-10 05:31:43

giscus-bot giscus-bot 2022-12-16 22:21:42
Guest *Tyler Rinker* @ 2013-05-25 03:40:28 originally posted:

I tried out the HTML version of building vignettes with the reports package: https://dl.dropboxusercontent.com/u/61803503/packages/reports_vignette.html. I liked it so much I added this as a report type people can build in the reports package. Thanks for working this out and getting this through CRAN. It was so easy. I'm hoping we see more HTML vignettes as you can do pretty nifty things with HTML vs other document types.

giscus-bot giscus-bot 2022-12-16 22:21:42
Guest *jeromyanglim* @ 2013-10-15 03:11:59 originally posted:

This is a great feature. In case it interests you or others I posted a question on StackOverflow on "How to get R CMD check to automatically compile R Markdown Vignettes?"
http://stackoverflow.com/questions/19372260/

giscus-bot giscus-bot 2022-12-16 22:21:43
Guest *Christian* @ 2015-02-15 02:51:26 originally posted:

Thanks for explaining how to make vignettes with knitr. For some reason, mine is not yet working. I tried looking at the "Writing R extensions" sections on vignettes, but felt confused. I have written a vignette and I am able to compile outside of my package using knitr. I have tried adding a "vignettes" folder to my package and put my .Rnw file there. In the .Rnw file, I added the two lines you suggested: "VignetteEngine{knitr::knitr}" and "VignetteIndexEntry{}". In the "description" file, I added the two lines you suggested: "VignetteBuilder: knitr" and "Suggests: knitr". Then, I tried to do R CMD check as usual. Is there something I'm missing?

giscus-bot giscus-bot 2022-12-16 22:21:47
Guest *Christian* @ 2015-02-15 03:06:14 originally posted:

Actually, I just made it compile. Thanks!

giscus-bot giscus-bot 2022-12-16 22:21:44
Guest *Alexandre Courtiol* @ 2016-09-05 09:31:47 originally posted:

"You have to specify the argument build_vingettes = TRUE when you install the package"
--> you have a typoe I guess: build_vingettes --> build_vignettes

yihui yihui 2022-12-16 22:21:48

Thanks! Fixed.

Originally posted on 2016-09-10 03:27:36

Sign in to join the discussion

Sign in with GitHub