search

bheavner / minidtools

A R package for working with BDDS minids
Other
1 stars 0 forks source link

figure out how to export in doxygen to get NAMESPACE right #2

Closed bheavner closed 6 years ago

bheavner commented 8 years ago

if my package is called minid (and thus described in minid.R), and my constructor is named minid, how do I document the constructor? - the string "mind" is overloaded, even if I split out minid-package.r:

?minid Using development documentation for minid Error in f(...) : rdFile must be a single element character vector. ?minid() Using development documentation for minid Error in f(...) : rdFile must be a single element character vector.

bheavner commented 8 years ago

see https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html

bheavner commented 8 years ago

See also https://github.com/joey711/testpkg

bheavner commented 8 years ago

I'm thinking I'll ignore the package description for now. ggplot2 doesn't seem to have one... Why should I?