{roxygen} R# Documentation

roxygen


require(R);

#' In-Line Documentation for R
imports "roxygen" from "roxygenNet";

In-Line Documentation for R

Generate your Rd documentation, 'NAMESPACE' file, And collation field using specially formatted comments. Writing documentation In-line With code makes it easier To keep your documentation up-To-Date As your requirements change. 'roxygenNet' is inspired by the 'roxygen2' system from Rstudio.



.NET clr function exports
parse

parse the R# symbol documents from a given r source script

roxygenize

Process a package with the Rd, namespace and collate roclets.

This is the workhorse function that uses roclets, the built-in document transformation functions, to build all documentation for a package. See the documentation for the individual roclets, rd_roclet(), namespace_roclet(), and for update_collate(), for more details.

markdown2Html

convert the markdown text content to html text

unixMan

generate unix man page and the markdown index page file


[Document Index]