将包文档呈现到github wiki中

时间:2014-12-12 20:53:33

标签: r r-markdown devtools roxygen2

问题:
是否有任何技巧可以将包文档Rd文件呈现到github wiki页面? github wiki页面支持标记:https://github.com/github/markup#markups

背景
html镜像上有大量的CRAN包doc。这种用于R文档的Web模板可以扩展为github托管包。如果可以Rd到维基,这将非常容易。许多甚至大多数github托管的软件包根本不使用wiki。

1 个答案:

答案 0 :(得分:2)

tools设计中有几个函数可以处理Rd个文件。

一种选择是将其转换为html,然后使用pandoc转换为降价:

#' Convert rd file to markdown
#' @param rd path to rd file
rd_to_markdown <- function(rd) {
    html <-  paste(rd, ".html", sep = "")
    tools::Rd2HTML(tools::parse_Rd(rd), out = html)
    system( paste("pandoc -s -r html ", html, " -o ", rd, ".text", sep=""))
    unlink(html)
}

结果很不错,但可能会更糟。