Skip to content
Prev 8510 / 12125 Next

[R-pkg-devel] Inquiry

On Mon, 26 Sep 2022 20:07:28 -0400
Andrew Simmons <akwsimmo at gmail.com> wrote:

            
My understanding is that functions, that are not meant to be called
directly by users, should be documented in a file named
<pkgnm>-internal.Rd.  It should have a structure something like:
Then if someone types, e.g., "help(clyde)" they get the processed
form of the forgoing *.Rd file displayed, and are thereby told that
they probably should not mess with clyde().

cheers,

Rolf Turner

P.S. I always export everything.

R. T.