writing documentation

Documentation is written in the R code, using the Roxygen2 convention. Some hints:

1. The documentation of function parameters should be of the form

#' @param epsilon numeric value indicating...

That is, start the explanation in lower-case, giving the type of the parameter.

2. Consider using templates for arguments that are repeated often (they go in the man-roxygen directory).

3. When a local or remote test indicates a broken link in documentation, follow the procedure listed at the section entitled handling broken links in documentation.