R/rd2md.R

In ropenscilabs/rtd:

#' Convert Rdoc to MarkDown
#'
#' Converts \code{Rd} files into markdown output.
#'
#' @export
#' @param file name of the \code{Rd} file
rd2md <- function(file){
  doc_data <- parse_rd_file(file)
  str <- paste("#", doc_data$title, "\n\n")
  append <- function(...){
    str <<- paste0(str, ..., "\n")
  }
  append("## Description")
  append(doc_data$desc)

  append("## Usage")
  append("```r", doc_data$usage, "\n```")

  if(length(doc_data$params)){
    append("## Arguments")
    append(paste(" -", doc_data$params, collapse = "\n"))
  }

  if(length(doc_data$details)){
    append("## Details")
    append(doc_data$details)
  }

  if(length(doc_data$references)){
    append("## References")
    append(doc_data$references)
  }

  if(length(doc_data$examples)){
    append("## Examples")
    append("```r", doc_data$examples, "\n```")
  }

  return(str)
}