Packaged don't find vignettes created with use-vignette

[jimhester]

Issue by smach
Thursday Sep 17, 2015 at 00:53 GMT
Originally opened as r-lib/devtools#931

---

Packages don't "find" vignettes created with use-vignette() -- that is, they're not listed in the package help or when runningvignette() and browseVignettes() -- without also running build_vignette(). Issue filed per this Twitter thread https://twitter.com/sharon000/status/644256000451694592

[jimhester]

Comment by jennybc
Thursday Nov 12, 2015 at 10:22 GMT

---

What IS the official party line on how to manage vignettes during development?

In your book, vignette workflow addresses the (ephemeral) preview. And development cycle gets at the other end ... when building and installing a package properly.

What about the bit in the middle?

[jimhester]

Comment by hadley
Thursday Nov 12, 2015 at 12:49 GMT

---

I preview them with Cmd + Shift + K. What else do you need to do during dev?

[jimhester]

Comment by jennybc
Thursday Nov 12, 2015 at 16:02 GMT

---

I'm thinking about the vignettes relative to what we do for roxygen comment / Rd file (and README.Rmd / README.md?).

The documentation workflow results in persistent help files you can preview in their natural habitat with ?. What's the equivalent for a vignette? The Cmd + Shift + K preview can be a drag because sometimes they take a long time to render.

It's not that I can't figure out how get a rendered vignette. It's about figuring out the most devtools-ish way to get and possibly hold on to them.

[jimhester]

Comment by hadley
Thursday Nov 12, 2015 at 19:11 GMT

---

Oh hmmmm, maybe we need a vignette() shim to get the dev version?

[hadley]

I think this needs a fix to install: r-lib/devtools#1578