Re: [Rd] Links to non-vignette documentation

2006-02-25 Thread Berwin A Turlach
G'day all, > "HW" == hadley wickham <[EMAIL PROTECTED]> writes: >> There aren't any immediate plans to change help(package=XXX), but I >> think in the long run, if package?XXX receives wider support than it has >> now, it would make sense to make that change. HW> When was this

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Berwin A Turlach
G'day all, > "DM" == Duncan Murdoch <[EMAIL PROTECTED]> writes: DM> On 2/24/2006 7:27 AM, Romain Francois wrote: >> >> What about using the latex package pdfpages to copy the pages from your >> PDF file `interface96.pdf` to your Sweave file. Merci beaucoup, I wasn't aware t

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Duncan Murdoch
On 2/24/2006 11:42 AM, hadley wickham wrote: >> > When was this form of package documentation created? How are users >> > supposed to know it exists? I couldn't find any pointers to it from >> > ?help, ?library or from help(package=XXX). >> >> It's described in the Writing R Extensions Manual, in

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Duncan Murdoch
On 2/24/2006 9:29 AM, hadley wickham wrote: >> No, there's no automatic building after the promptPackage call. It's up >> to you to decide which functions need to be mentioned to users. In >> large packages it usually doesn't make sense to list all the functions, >> so the package writer needs to

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Hin-Tak Leung
Duncan Murdoch wrote: >>\usepackage{pdfpages} > That's a nice hack. You probably want the "fitpaper" option on the > \includepdf command, so that you don't get an extra border around the > page. For example, this file test.Rnw > The only disadvantages I see are that both the test.pdf and res

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread hadley wickham
> No, there's no automatic building after the promptPackage call. It's up > to you to decide which functions need to be mentioned to users. In > large packages it usually doesn't make sense to list all the functions, > so the package writer needs to use judgement here. There are other > mechanis

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Duncan Murdoch
On 2/24/2006 7:27 AM, Romain Francois wrote: > > What about using the latex package pdfpages to copy the pages from your > PDF file `interface96.pdf` to your Sweave file. (I don't know if it is > compatible with Sweave). > > Not tested : > > \documentclass[a4paper]{article} > %\VignetteIndexEn

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Romain Francois
Le 24.02.2006 01:26, Berwin A Turlach a écrit : > G'day all, > > seems as if I must have slept through most of this most interesting > discussion. :) > > >> "BR" == Prof Brian Ripley <[EMAIL PROTECTED]> writes: >> > > BR> On Thu, 23 Feb 2006, hadley wickham wrote: >

Re: [Rd] Links to non-vignette documentation

2006-02-24 Thread Duncan Murdoch
On 2/23/2006 10:02 PM, hadley wickham wrote: >> They are meant to replace the INDEX, which you shouldn't need to create >> any more. The DESCRIPTION file is still needed, but it contains more >> structured information meant for mechanical reading and processing; the >> package man page is meant to

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Gabor Grothendieck
I haven't followed this whole thread but note that if your package is called mypkg then you can create an .Rd file called mypkg-package.Rd which will be called up when the user issues: package?mypkg and that can contain links to whatever you are interested in. Try library(dyn) package?dyn for

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread hadley wickham
> They are meant to replace the INDEX, which you shouldn't need to create > any more. The DESCRIPTION file is still needed, but it contains more > structured information meant for mechanical reading and processing; the > package man page is meant to be the place to put things intended for > people

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Duncan Murdoch
On 2/23/2006 5:49 PM, hadley wickham wrote: >> We were referring to an HTML index file. If you want to have a >> reference from your package man page (foo-package.Rd) or some other man >> page, you can use \url{../doc/my.pdf} and the link will work in HTML >> versions of help, and won't be too mis

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Berwin A Turlach
G'day all, seems as if I must have slept through most of this most interesting discussion. :) > "BR" == Prof Brian Ripley <[EMAIL PROTECTED]> writes: BR> On Thu, 23 Feb 2006, hadley wickham wrote: >> How can I write an index file with a pointer to my pdf? Should >> I provide a c

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread hadley wickham
> We were referring to an HTML index file. If you want to have a > reference from your package man page (foo-package.Rd) or some other man > page, you can use \url{../doc/my.pdf} and the link will work in HTML > versions of help, and won't be too misleading in other versions > (especially if you e

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Duncan Murdoch
On 2/23/2006 4:23 PM, hadley wickham wrote: >> I think you need to define `vignette'. I understand the usage to mean an >> Sweave file. There are ways to include other PDF files, and you can write >> your own index file. R can't do that for you as it cannot read PDF (it >> can read Sweave). > >

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Prof Brian Ripley
On Thu, 23 Feb 2006, hadley wickham wrote: >> I think you need to define `vignette'. I understand the usage to mean an >> Sweave file. There are ways to include other PDF files, and you can write >> your own index file. R can't do that for you as it cannot read PDF (it >> can read Sweave). > >

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread hadley wickham
> I think you need to define `vignette'. I understand the usage to mean an > Sweave file. There are ways to include other PDF files, and you can write > your own index file. R can't do that for you as it cannot read PDF (it > can read Sweave). How can I write an index file with a pointer to my

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Prof Brian Ripley
On Thu, 23 Feb 2006, hadley wickham wrote: Is there anyway to have my pdf documentation listed under vignettes other than making it a sweave file? >> >> No, a vignette is regarded as an Sweave file. > > It would be useful if there was a mechanism to allow arbitrary pdf > files to be incl

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread hadley wickham
> >> Is there anyway to have my pdf documentation listed under vignettes > >> other than making it a sweave file? > > No, a vignette is regarded as an Sweave file. It would be useful if there was a mechanism to allow arbitrary pdf files to be included as vignettes. There are many other ways to in

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Prof Brian Ripley
On Thu, 23 Feb 2006, Duncan Murdoch wrote: > On 2/23/2006 11:53 AM, hadley wickham wrote: >> Section 1.4 of Writing R Extensions says: >> >> In addition to the help files in Rd format, R packages allow the >> inclusion of documents in arbitrary other formats. The standard >> location for these is

Re: [Rd] Links to non-vignette documentation

2006-02-23 Thread Duncan Murdoch
On 2/23/2006 11:53 AM, hadley wickham wrote: > Section 1.4 of Writing R Extensions says: > > In addition to the help files in Rd format, R packages allow the > inclusion of documents in arbitrary other formats. The standard > location for these is subdirectory inst/doc of a source package, the > c

[Rd] Links to non-vignette documentation

2006-02-23 Thread hadley wickham
Section 1.4 of Writing R Extensions says: In addition to the help files in Rd format, R packages allow the inclusion of documents in arbitrary other formats. The standard location for these is subdirectory inst/doc of a source package, the contents will be copied to subdirectory doc when the packa