[Roxygen-devel] S4 documentation

[Hadley Wickham]

> For the most part, packages that I've written (and am currently writing) have complex classes that store and process a large amount of data. There are usually many generics with only a single method each. The xcms package has several such classes:
>
> http://www.bioconductor.org/packages/release/bioc/html/xcms.html
>
> For that package, some of of the methods were so simple that the method/generic documentation was kept in the class itself, which would add a type of documentation to the list below. More complex methods got their own page.

In that case, why both creating a generic at all?  Why not just use a
regular function?

Regardless, I think that case doesn't need any underlying changes. So
long as @rdname works, you can combine any arbitrary
functions/classes/methods into a single documentation file.

Hadley


-- 
Assistant Professor / Dobelman Family Junior Chair
Department of Statistics / Rice University
http://had.co.nz/