[R-pkg-devel] problems documenting data sets

[Rolf Turner]

It's hard to be sure without seeing your package, but it *sounds* as 
though you have a data set "Brom" (in <package>/data ?) but you have 
*documented* a data set named "brom".  So you should either change the 
name of the data set to "brom" or change your help file to document "Brom".

It is of course entirely possible that I am misunderstanding what is 
going on, in which case I apologise for the noise.

cheers,

Rolf

-- 
Honorary Research Fellow
Department of Statistics
University of Auckland
Phone: +64-9-373-7599 ext. 88276

On 1/19/19 11:46 PM, Troels Ring wrote:
> Dear friends – I still get some warning although the package runs just fine.
> 
> checking for missing documentation entries ... WARNING
> 
>    Undocumented data sets:
> 
>      'Cl' 'K' 'Na' 'TOTAL' 'WA' 'INPUT' 'Alb' 'Ca' 'Lact' 'Mg' 'PCO2' 'S1'
> 
>      'Brom' 'pHOBS'
> 
>    All user-level objects in a package should have documentation entries.
> 
>    See chapter 'Writing R documentation files' in the 'Writing R
> 
>    Extensions' manual.
> 
>   
> 
> 0 errors v | 1 warning x | 0 notes v
> 
> Fejl: R CMD check found WARNINGs
> 
> K�rsel stoppet (run stopped)
> 
>   
> 
> But the only place I have  any mentions of brom is here below and in no place I have capital Brom. So what should I make of this?
> 
>   
> 
> \name{brom}
> 
> \alias{brom}
> 
> \docType{data}
> 
> \title{
> 
> Bromic acid data from Glaser et al 2014
> 
> }
> 
> \description{
> 
>    Data to find optimal pK for bromic acid
> 
> }
> 
> \usage{data("brom")}
> 
> \format{
> 
> A workspace.
> 
>    \describe{
> 
>      \item{brom}{Dataframe of Table S4 in Glaser et al.}
> 
>      \item{WA}{List of buffers with list of dissociation constants.}
> 
>    }
> 
> }
> 
> \source{
> 
> Glaser RE et al. Dynamical approach to multiequilibriia problems for mixtures of
> 
> acids and their conjugate bases. J Chem Educ 2014; 91: 1009-1016
> 
> }
> 
> \examples{
> 
> data(brom)
> 
> ## maybe str(brom) ; plot(brom) ...
> 
> }
> 
> \keyword{datasets}