S4 Method Documentation

Asked Mar 09 '16 at 22:57

Active Mar 09 '16 at 23:04

Viewed 212 times

I am getting a build warning: Undocumented S4 methods: generic 'plot' and siglist 'cd.fit,missing'

and can't figure out what isn't documented. Here is what the method documentation looks like:

##' Something here
##' @param a bunch of paramter defs
##' @aliases plot,cd.fit,cd.fit-method
##' @rdname plot-methods
##' @importFrom graphics plot
##' @exportMethod plot
setMethod("plot",
      signature(x = "cd.fit",y="missing"),
      function(x,y,col.main=rgb(230, 85, 13,maxColorValue=255),...){

..code here ..

})

I have looked through a number of other SO postings that ask similar questions but can't seem to figure out why this is any different except perhaps the generic signature for plot only has two elements and I am adding extras. Any thoughts/suggestions?

edited Mar 09 '16 at 23:04

rawr

20,481
4
44
78

asked Mar 09 '16 at 22:57

scottyaz

For every exported method you need to have a help file. – IRTFM Mar 09 '16 at 22:58
@42- are you saying that roxygen2 won't generate this from what I have here? – scottyaz Mar 09 '16 at 23:01
1

It looks wrong to me. I've not seen the use of double octothorpes. Wondering if your lines are being "seen". – IRTFM Mar 09 '16 at 23:25
should that be `##' @aliases plot,cd.fit,missing-method` ? – Martin Morgan Mar 10 '16 at 00:03

S4 Method Documentation

0 Answers0