Render package documentation into github wiki

Question

Question:
Are there any tricks which would render package documentation Rd files into github wiki pages?
github wiki pages supported markups: https://github.com/github/markup#markups

Background:
There are tons of CRAN packages doc on html mirrors. This kind of web-template for R documentation could be extended for github hosted packages. If Rd to wiki would be possible this would be very easy. Many, maybe even most of, github hosted packages do not use wiki at all.

Question how one could use which particular function to transform Rd file into github wiki page. I understand it is quite an open question. — jangorecki
– jangorecki, Commented Dec 12, 2014 at 21:01
As it stands, it could be closed as off-topic (looking for a tool). I don't know what a good hub would be for such questions. — Roman Luštrik
– Roman Luštrik, Commented Dec 12, 2014 at 21:07
Recently Rmd was allowed to be rendered as markdown. Maybe try an FR there for Rd as well (although it's not exactly the same)? — Arun
– Arun, Commented Dec 12, 2014 at 21:41
Well, not for wiki pages, but gh-pages could use github.com/hadley/staticdocs — daroczig
– daroczig, Commented Dec 12, 2014 at 23:30

zero323 · Accepted Answer · 2014-12-12 23:27:35Z

2

There is a couple of functions in tools design to work with Rd files.

One option would be to convert it to html and then to markdown using 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)
}

Result is far form pretty but it could be worse.

answered Dec 12, 2014 at 23:27

zero323

331k108 gold badges981 silver badges958 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Render package documentation into github wiki

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related