From xie at yihui.name  Thu Oct  3 04:44:52 2013
From: xie at yihui.name (Yihui Xie)
Date: Wed, 2 Oct 2013 21:44:52 -0500
Subject: [Rd] Error in "Writing R Extensions"
In-Reply-To: <DC06513B-AFAB-47C9-997B-293537331425@anu.edu.au>
References: <DC06513B-AFAB-47C9-997B-293537331425@anu.edu.au>
Message-ID: <CANROs4fkbUQ73RA=HsGxpFiD03iGSSM=kKMvHfLHcEMtiaFwvw@mail.gmail.com>

The double colon :: can be confusing here, but the R-exts manual is
actually correct. :: does not imply anything about the package
namespace; it is merely a separator. The vignette engines are written
in the form package::engine, and the engine name _happens_ to be
"knitr" as well in this case.

> library(knitr)
> str(tools::vignetteEngine(name='knitr', package='knitr'))
List of 5
 $ name   : chr "knitr"
 $ package: chr "knitr"
 $ pattern: chr "[.]([rRsS](nw|tex)|[Rr](md|html|rst))$"
 $ weave  :function (file, driver, syntax, encoding = "", quiet = FALSE, ...)
 $ tangle :function (file, driver, syntax, encoding = "", quiet = FALSE, ...)

I admit the engine name "knitr" is also confusing. There are other
engine names in knitr, though. For example, knitr::docco_classic
http://cran.r-project.org/web/packages/knitr/vignettes/docco-classic.html

Regards,
Yihui
--
Yihui Xie <xieyihui at gmail.com>
Web: http://yihui.name
Department of Statistics, Iowa State University
2215 Snedecor Hall, Ames, IA


On Wed, Oct 2, 2013 at 9:24 PM, John Maindonald
<john.maindonald at anu.edu.au> wrote:
> In Section 1.4.2 of "Writing R Extensions"
>      %\VignetteEngine{knitr::knitr}
> should be
>      %\VignetteEngine{knitr::knit}
>
>> sessionInfo()
> R version 3.0.2 (2013-09-25)
> Platform: x86_64-apple-darwin10.8.0 (64-bit)
>
> Is this sort of thing best reported here, or is a huge report in order?
>
> John Maindonald             email: john.maindonald at anu.edu.au
> phone : +61 2 (6125)3473    fax  : +61 2(6125)5549
> Centre for Mathematics & Its Applications, Room 1194,
> John Dedman Mathematical Sciences Building (Building 27)
> Australian National University, Canberra ACT 0200.



[Rd] Error in "Writing R Extensions"
Yihui Xie