From sven.templer at gmail.com Tue Aug 19 18:25:22 2014 From: sven.templer at gmail.com (Sven E. Templer) Date: Tue, 19 Aug 2014 18:25:22 +0200 Subject: [Roxygen-devel] Multiple space separated parameter Message-ID: Dear list, I came across an issue filed in 2011 as git(hub) repository issue [1], then on this mailing list [2] (with no reply) and nowadays on stackoverflow [3]. The issue is about providing a method to use @param with multiple arguments which are comma AND space separated to allow a line break in the final Rd file. Examples can be found on SO [3]. Are there any attempts to include a solution as suggested in [1,2] such as @multParam 3 a b c Description or @param {a, b, c} Description ? I would prefer the second format, with [],{} or (). Thank you, Sven. [1] https://github.com/klutometis/roxygen/pull/31 [2] http://lists.r-forge.r-project.org/pipermail/roxygen-devel/2011-October/000315.html [3] http://stackoverflow.com/questions/25308059/generate-items-with-multiple-arguments-in-an-r-documentation-via-roxygen2 From cboettig at gmail.com Tue Aug 19 18:36:09 2014 From: cboettig at gmail.com (Carl Boettiger) Date: Tue, 19 Aug 2014 09:36:09 -0700 Subject: [Roxygen-devel] Documenting S4 methods with class names that are not valid filenames? Message-ID: 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 into stmml:ListOfunit objects #' @param x,... units to concatenate #' @param recursive not implemented at this time #' @rdname class-stmml:unit setMethod("c", signature("stmml:unit"), function(x, ..., recursive = FALSE) new("stmml:ListOfunit", list(x, ...))) How would I modify this to create valid documentation? Currently this will error that rdname is not a valid filename, but changing the rdname (e.g. just removing the ":") results in a new error about undocumented methods. Thanks! Carl -- Carl Boettiger UC Santa Cruz http://carlboettiger.info/ -------------- next part -------------- An HTML attachment was scrubbed... URL: