[Rd] markdown vignette with the vignette command
Leo Lahti
leo.lahti at iki.fi
Fri Aug 22 14:42:10 CEST 2014
I followed the instructions in
http://cran.r-project.org/web/packages/knitr/vignettes/knitr-markdown.html
- add *.Rmd files under the vignettes directory
- add VignetteBuilder: knitr to the DESCRIPTION file
- specify the vignette engine \VignetteEngine{knitr::knitr} in the Rmd
files (inside HTML comments)
Leo
On Fri, Aug 22, 2014 at 2:36 PM, Duncan Murdoch <murdoch.duncan at gmail.com>
wrote:
> On 22/08/2014 8:06 AM, Leo Lahti wrote:
>
>> Solved, thanks!
>>
>> Could you post a short description of the solution, in case this problem
> arises for anyone else? These posts are archived, and can be a useful
> resource for others.
>
> Duncan Murdoch
>
>
>> On Fri, Aug 22, 2014 at 1:04 PM, Duncan Murdoch <murdoch.duncan at gmail.com
>> <mailto:murdoch.duncan at gmail.com>> wrote:
>>
>> On 22/08/2014, 6:09 AM, Leo Lahti wrote:
>> > Dear list,
>> >
>> > we have a markdown vignette for our package in
>> vignette/vignette.md <http://vignette.md>
>>
>> >
>> > This is not visible from within R with the vignette(package =
>> "mypackage")
>> > command.
>> >
>> > I assume the reason is that the vignette function only shows PDF
>> vignettes.
>> > Is there any way to circumvent this and display markdown
>> vignettes directly
>> > from within R?
>> >
>> > I tried to seek the answer from R archives and search engines
>> but could not
>> > find the solution so far.
>> >
>>
>> If you are using a current version of R, it should just work. For
>> example,
>>
>> vignette("knitr-markdown")
>>
>> works for me when knitr is attached. If knitr was not attached, I'd
>> have to list it in the pkg argument of the vignette call.
>>
>> Duncan Murdoch
>>
>>
>>
>
[[alternative HTML version deleted]]
More information about the R-devel
mailing list