From ggrothendieck at gmail.com  Fri Feb 24 04:40:48 2006
From: ggrothendieck at gmail.com (Gabor Grothendieck)
Date: Thu, 23 Feb 2006 22:40:48 -0500
Subject: [Rd] Links to non-vignette documentation
In-Reply-To: <f8e6ff050602231902i6b999b8m952a58ff459e6914@mail.gmail.com>
References: <f8e6ff050602230853l7eb9cfe6n7458e718ce7934b3@mail.gmail.com>
	<43FE042B.4080601@stats.uwo.ca>
	<Pine.LNX.4.64.0602232010470.17594@gannet.stats.ox.ac.uk>
	<f8e6ff050602231237j12689b32i511425b6948766a1@mail.gmail.com>
	<Pine.LNX.4.64.0602232044190.25797@gannet.stats.ox.ac.uk>
	<f8e6ff050602231323m7a0779bdrb694f85758df6f3d@mail.gmail.com>
	<43FE3453.6020405@stats.uwo.ca>
	<f8e6ff050602231449l187478f1mcb166915b02c4f3e@mail.gmail.com>
	<43FE66A5.3090103@stats.uwo.ca>
	<f8e6ff050602231902i6b999b8m952a58ff459e6914@mail.gmail.com>
Message-ID: <971536df0602231940g169821cal766dd924531383a3@mail.gmail.com>

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 an example.  The R command, promptPackage, can be
used to facilitate the creation of the -package.Rd file.


On 2/23/06, hadley wickham <h.wickham at gmail.com> 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 be the place to put things intended for
> > people to read.
>
> Do I need to keep the list of functions on the package man page in
> sync myself, or will they be automatically rebuilt?  Is the intention
> to eventually change help(package=XXX) to point to the package man
> page?
>
> Hadley
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



[Rd] Links to non-vignette documentation
Gabor Grothendieck