R help - Aug 2006 - missing documentation entries

Dear list,

When creating a package, there are always many little utility functions that 
belong to the "internal kitchen" of the main, documented functions.
Now, when checking the sources with R CMD check, I get a warning for those 
little functions that are not documented.
I would have two questions:
- is it mandatory to document _all_ functions (will the source package be 
rejected by CRAN if otherwise)?
- if not, is there a way to tell R which are the functions that I don't want
to document?

Thanks,
Adrian

-- 
Adrian Dusa
Romanian Social Data Archive
1, Schitu Magureanu Bd
050025 Bucharest sector 5
Romania
Tel./Fax: +40 21 3126618 \
          +40 21 3120210 / int.101

This is discussed in `Writing R Extensions', which both points you to the 
'internal' keyword, and (in the current version) mentions using name 
spaces to hide such functions.

This really was a question for R-devel: please do study the posting guide. 

  `R-devel is intended for questions and discussion about code development 
  in R.'


On Wed, 9 Aug 2006, Adrian Dusa wrote:
> 
> Dear list,
> 
> When creating a package, there are always many little utility functions
that
> belong to the "internal kitchen" of the main, documented
functions.
> Now, when checking the sources with R CMD check, I get a warning for those 
> little functions that are not documented.
> I would have two questions:
> - is it mandatory to document _all_ functions (will the source package be 
> rejected by CRAN if otherwise)?
> - if not, is there a way to tell R which are the functions that I don't
want
> to document?
> 
> Thanks,
> Adrian
> 
> 
-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595