From edd at debian.org  Sat Jul 13 17:40:21 2013
From: edd at debian.org (Dirk Eddelbuettel)
Date: Sat, 13 Jul 2013 10:40:21 -0500
Subject: [Rd] "Proper" way to use a "hidden" function in an R-package?
In-Reply-To: <CADwqtCMZnRVZq7vaexrmjaM3K+Hycim4prwuBoE0ncu0gXYBAw@mail.gmail.com>
References: <CABG0rfuVhzEB1s-287dAfCHMDcsWL9dLDAfaLennbQNMYOjNEw@mail.gmail.com>
	<72e8fb0d815546218d6a34ae88d1100d@CHIHT1.ad.uillinois.edu>
	<CABG0rftQLsvWdkU_Sj=xYyYYt-Xb6B5rZn1-VOtcSOiap+eEgA@mail.gmail.com>
	<CADwqtCMZnRVZq7vaexrmjaM3K+Hycim4prwuBoE0ncu0gXYBAw@mail.gmail.com>
Message-ID: <20961.29925.394385.528222@max.nulle.part>


On 12 July 2013 at 11:42, Gabriel Becker wrote:
| Jonathan,
| 
| All exported functions must have documentation entries to pass R CMD check
| without warnings.
| 
| Functions within your package do not need another function in your package
| to be exported to call it without :::, but code not in your package (ie
| functions in other packages or user code) do.
| 
| If you have reason to believe that a user or function from another package
| will directly call a function, it should be exported, and thus documented.
| If not, you can use them within code in your own package without exporting
| them, using :::, or documenting them.

All true, but what Jonathan _really_ wanted to know is that adding a single 

    \alias{nameOfThatFunction}

in an .Rd file will also satisfy R CMD check.  Some package use a file
undocumented.Rd to regreoup these; I sometimes use the Packagename-package.Rd
file.

Dirk

-- 
Dirk Eddelbuettel | edd at debian.org | http://dirk.eddelbuettel.com



[Rd] "Proper" way to use a "hidden" function in an R-package?
Dirk Eddelbuettel