[Rd] CRAN: How to list a non-Sweave doc under "Vignettes:" on package page?
xie at yihui.name
Mon Nov 7 03:09:09 CET 2011
Thanks, and sorry for hijacking. I tried it once and gave up later
because I do not want hard-coded files (may be good or bad, though).
My point is that both CRAN and the package documentation are
restricted to Sweave for automatic generation of the vignette list. I
was hoping that vigettes could be like demos, which are listed in
demo/00Index by package authors and will show up in demo(package =
xxx). I apologize if this is irrelavent to your question.
Yihui Xie <xieyihui at gmail.com>
Phone: 515-294-2465 Web: http://yihui.name
Department of Statistics, Iowa State University
2215 Snedecor Hall, Ames, IA
On Sun, Nov 6, 2011 at 7:51 PM, Henrik Bengtsson <hb at biostat.ucsf.edu> wrote:
> On Sun, Nov 6, 2011 at 5:14 PM, Yihui Xie <xie at yihui.name> wrote:
>> I have the same question. I wish vignettes which are shown in CRAN and
>> the package documentation are not restricted to Sweave (or I missed
>> something in the R-exts manual?). What I did in the past was to cheat
>> Sweave by putting an Rnw document which is essentially a tex document
>> (I used my own functions to compile Rnw to tex).
> How CRAN behaves and how the help package system behaves may be two
> different problems. My question is specifically on how CRAN works.
> To have inst/doc/ documents to be listed on the package's help page,
> you can add an inst/doc/index.html file, cf. Section 'Writing package
> vignettes' in 'Writing R Extensions'. You can use the following
> index.html file as a template:
> url <- sprintf("http://127.0.0.1:%s/library/utils/doc/index.html",
> download.file(url, basename(url));
>> Yihui Xie <xieyihui at gmail.com>
>> Phone: 515-294-2465 Web: http://yihui.name
>> Department of Statistics, Iowa State University
>> 2215 Snedecor Hall, Ames, IA
>> On Sun, Nov 6, 2011 at 6:41 PM, Henrik Bengtsson <hb at biostat.ucsf.edu> wrote:
>>> is it possible to have non-Sweave vignettes(*) in inst/doc/ be listed
>>> under 'Downloads' on CRAN package pages? For instance, in my R.rsp
>>> package I have a inst/doc/report.pdf (part of the source *.tar.gz)
>>> that is not detected/listed. The PDF is not based on a Sweave
>>> vignette but an *.tex.rsp vignette that is dynamically created via
>>> inst/doc/Makefile. It is listed
>>> (*) BTW, can the term "vignette" be used for any inst/doc/ document,
>>> or should it be reserved for Sweave+LaTeX-based documents?
>>> R-devel at r-project.org mailing list
>> R-devel at r-project.org mailing list
More information about the R-devel