[Roxygen-devel] Documenting S4 methods with class names that are not valid filenames?

2014-08-19 Thread Carl Boettiger
HI List, I have the misfortune to have an object class I'd like to document an S4 method for, in which the object class name is not a valid filename (do to having a ":"). The method and the Roxygen documentation are thus: #' concatenate stmml:unit objects #' #' concatenates stmml:unit objects i

[Roxygen-devel] Documenting S4 methods

2012-09-12 Thread Hadley Wickham
Hi all, After a survey of packages that use S4 and talking to a few people who use S4 a lot, here are my thoughts on how method documentation would work. Methods need to be documented in three places: * individually, for complex methods * in the class (briefly) * in the generic (briefly) This d