R/Rd2md-package.R

In Rd2md: Markdown Reference Manuals

#' @name Rd2md-package
#' @docType package
#' @title Reference Manual in Markdown
#' @description Functions to parse and convert Rd files to markdown format reference manual.
#' @author Julian Busch <jb@quants.ch>
#' @keywords Rd help markdown reference manual
#' @seealso \code{knitr}
#' @import tools
#' @import knitr
NULL

sections <- c("\\arguments", "\\author", "\\concept", "\\description",
			  "\\details", "\\docType", "\\encoding", "\\format", "\\keyword", "\\name",
			  "\\note", "\\references", "\\section", "\\seealso", "\\source", "\\title",
			  "\\value", "\\examples", "\\usage", "\\alias", "\\Rdversion", "\\synopsis",
			  "\\Sexpr", "\\RdOpts" )

sections.print <- c("name", "title", "description", "format", "usage", "arguments", 
					"details", "value", "seealso", "note", "author", 
					"references", "examples")

markups.latex <- c("\\acronym", "\\bold", "\\cite", "\\command", "\\dfn",
				   "\\dQuote", "\\email", "\\emph", "\\file", "\\item", "\\linkS4class",
				   "\\pkg", "\\sQuote", "\\strong", "\\var", "\\describe", "\\enumerate",
				   "\\itemize", "\\enc", "\\if", "\\ifelse", "\\method", "\\S3method",
				   "\\S4method", "\\tabular", "\\subsection", "\\link", "\\href" )

markups.r <- c("\\cr", "\\dots", "\\ldots", "\\R", "\\tab", "\\code", "\\dontshow",
			   "\\donttest", "\\testonly", "\\dontrun", "\\env", "\\kbd", "\\option",
			   "\\out", "\\preformatted", "\\samp", "\\special", "\\url", "\\verb",
			   "\\deqn", "\\eqn", "\\newcommand", "\\renewcommand")