Re: [R-pkg-devel] Documenting S4 generic does not show usage

2016-03-21 Thread Hadley Wickham
1. Depends on whether you're documenting the method or the generic. 2. You don't 3. I can never remember. I think if it's your generic, you only need it in one place. Hadley On Mon, Mar 21, 2016 at 11:06 AM, Manny Calavera wrote: > Thank you so much, it works like a charm :-) > > I would appreci

Re: [R-pkg-devel] Documenting S4 generic does not show usage

2016-03-21 Thread Manny Calavera
Thank you so much, it works like a charm :-) I would appreciate if you could please answer (very briefly) questions 1 to 3, so I can learn how to correctly document S4 generics properly in the future. Thanks again. 2016-03-18 15:11 GMT+01:00 Hadley Wickham : > The problem seems to be your use o

[R-pkg-devel] Documenting S4 generic does not show usage

2016-03-19 Thread Manny Calavera
Good day to everyone, I have an issue when documenting an S4 generic. I have the following in my file generics.R: #' @rdname myfunction-methods#' @name myfunction <- without this, roxygen2 complaints about missing name#' @export methods::setGeneric("myfunction", function( arg1, arg2 ), arg

Re: [R-pkg-devel] Documenting S4 generic does not show usage

2016-03-19 Thread Hadley Wickham
The problem seems to be your use of methods::setMethod instead of setMethod (etc). Roxygen2 doesn't seem to be quite smart enough to realise that these aren't equivalent. You might want to file an issue on github so I look into this the next time I'm working on roxygen2. Hadley On Fri, Mar 18, 20