ringbp
ringbp copied to clipboard
Incomplete Documentation
The documentation is generally incomplete.
While it has the appearance of completeness, it does not include critical elements:
- params should specific what class of object. e.g.,
@param num.initial.cases integer vector: the number of initial cases - ibid for function inputs, indicating
function(x), x integer, returns y double - document what class of object is being returned, and for tables / named objects, what columns, names will be present
More @examples would be nice (and required for CRAN), but not strictly necessary