[R] .Rd file exists in 'man' directory, but R CMD CHECK results in warning

[Duncan Murdoch]

On 19/06/2008 7:25 PM, dave gregovich wrote:
> Hello,
> My package has passed all the R CMD CHECK steps except one. There is an
> object which I placed in a sysdata.rda file (located in the 'R' directory of
> the source package). Even though users have no need to access this object,
> which is a character vector of parameters fed to Fortran code, R CMD CHECK
> produces a warning that it needs documentation. So I made an .Rd file for
> it. However, I still receive a warning:
> 'All user-level objects should have documentation entries'
> 
> All of the other .Rd files I have made for functions and for datasets are
> recognized and apparently OK with the check process. All .Rd files are
> located in a 'man' directory of the source package. All of my data files
> (.rda files) are sourced from a 'data' directory of the source package. The
> sysdata.rda file that contains the data which R CMD CHECK says I am not
> providing documentation for is in the  'R' directory of the source package.
> In case it matters, the .Rd file R CMD CHECK is not recognizing contains the
> following:
> 
> \name{CLC.PAR}
> \docType{sysdata}
> \alias{CLA.PAR}

I assume the object is named CLC.PAR, and so this looks like a typo. 
You need to list the object as an alias, not just as the name of the .Rd 
file.

Duncan Murdoch

> \title{Parameters for the Catch-Limit Algorithm}
> \description{
> This file contains parameters for input to the CLA. This file should not be
> tampered with.
> }
> \usage{CLC.PAR}
> \format{Character vector of 14 parameters}
> \keyword{sysdata}
> 
> The ideal solution is to not have R CMD CHECK make me do a help file for
> this object. But if I have to, that's fine, if it will result in a package
> that checks out completely.
> 
> Thanks kindly aforehand for any time one of you spends with my problem.
> 
> Dave Gregovich
> NOAA Southwest Fisheries Science Center
> Protected Resources Division
> La Jolla, CA 92037
> 858-546-7161
> dave.gregovich at noaa.gov
> 
> 	[[alternative HTML version deleted]]
> 
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.