From berwin at maths.uwa.edu.au  Sat Feb 25 09:34:47 2006
From: berwin at maths.uwa.edu.au (Berwin A Turlach)
Date: Sat, 25 Feb 2006 16:34:47 +0800
Subject: [Rd] Links to non-vignette documentation
In-Reply-To: <f8e6ff050602240629j2f31d4e7g23dd726472010114@mail.gmail.com>
References: <f8e6ff050602230853l7eb9cfe6n7458e718ce7934b3@mail.gmail.com>
	<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>
	<43FEF2E3.3070609@stats.uwo.ca>
	<f8e6ff050602240629j2f31d4e7g23dd726472010114@mail.gmail.com>
Message-ID: <17408.5799.865648.376306@bossiaea.maths.uwa.edu.au>

G'day all,

>>>>> "HW" == hadley wickham <h.wickham at gmail.com> 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 form of package documentation created?
Well, the section in "Writing R extensions" on "Documenting packages"
appeared first in the version for R 2.2.0.  My impression is that this
form of package documentation was created in response to the following
discussion:
        http://tolstoy.newcastle.edu.au/R/devel/05/06/index.html#1141
In particular, look at message :
        http://tolstoy.newcastle.edu.au/R/devel/05/06/1161.html
in that thread.

    HW> How are users supposed to know it exists?
By asking questions (or following the discussions) on r-help and r-devel? ;-))

More seriously, as Duncan pointed out in his reply, this is a
relatively new feature and few packages support it.  But I guess
sooner or later this feature will be advertised more widely, if only
because of it being again and again mentioned in discussions on r-help
and r-devel.

Cheers,

        Berwin



[Rd] Links to non-vignette documentation
Berwin A Turlach