On 4/5/06, Gabor Grothendieck <ggrothendieck@gmail.com> wrote:
>
> On 4/5/06, Uwe Ligges <ligges@statistik.uni-dortmund.de> wrote:
>
> >
> > What about an additional help page that relates to the whole package
> > rather than to a single function and contains the examples? Each
> > function's help page can point with a \link{} to that help page.
> >
>
> And that page would be of the form: mypkg-package.Rd and you
> could use the R promptPackage command to generate an outline
> for it.
>

That would be perfect, thank you for the suggestion. The discussion of
package help in the "Writing R Extension" manual led me to believe that
this was the wrong approach:
"More extensive documentation is better placed into a package vignette
(see Writing
package vignettes<http://cran.r-project.org/doc/manuals/R-exts.html#Writing-package-vignettes>)
and referenced from this page, or into individual man pages for the
functions, datasets, or classes."

The other suggestion given, by Prof. Ripley,  was to include examples(B) as
part of the documentation for C, and so on.

Thank you all,
Sarah

--
Sarah Goslee
http://www.stringpage.com

	[[alternative HTML version deleted]]


