You might also or instead look at the roxygen way of doing things, which
maps to Rd files, but are much easier to write. In R Studio,
Code -> Insert Roxygen skeleton does this for you from an existing
function. See: http://r-pkgs.had.co.nz/man.html
#' title goes here
#'
#' description goes here
#'
#' @param p1 desc of p1
#' @param p2
#' @param ...
#' @return
#' @export
#' @imports
#' @author
#' @seealso
#' @examples
#' example lines
foo <- function (p1, p2, ... ) {
}
On 9/7/2016 12:46 PM, Duncan Murdoch wrote:
On 07/09/2016 11:35 AM, Doran, Harold wrote:
I'm building a large program with many different people contributing
to the coding in R and so it needs a well-articulated design spec. The
program will have many different functions that must interact with
each other, but the individual functions will be written by different
people.
I'm curious if anyone has an R-specific SRS document to share that
they have used for a similar purpose listing the objectives for each
function, class definition, generics, what the function inherits from,
and so on, or perhaps even a useful template for such work.
The Rd help pages do some of this. They aren't so good at describing
the class hierarchy but are good at specifying individual functions.
Duncan Murdoch
______________________________________________
R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
