Insert markdown table in roxygen2 R package documentation

Question

I'm writing an R package and I want to include a table in an R help file, e.g. in the @details section. I tried including markdown code directly:

#' | Tables        | Are           | Cool  |
#' | ------------- |:-------------:| -----:|
#' | col 3 is      | right-aligned | $1600 |
#' | col 2 is      | centered      |   $12 |

But this does not give me the desired output. I have enabled markdown support for the whole package and have roxygen2 6.0.1 installed. Is there no support for markdown tables? Do I have to use \tabular{}?

Answer 1

You need to add the @md tag to your roxygen chunk

#' @details
#' The table is: 
#'
#' | Tables        | Are           | Cool  |
#' | ------------- |:-------------:| -----:|
#' | col 3 is      | right-aligned | $1600 |
#' | col 2 is      | centered      |   $12 |
#' 
#' @md

or add Roxygen: list(markdown = TRUE) to your DESCRIPTION file.

Answer 2

Note that {roxygen} generates R Documentation files in the end. Thus, you can always go to the Writing R Extensions: Lists and tables and write the table in the native documentation language for R-packages by hand.

Here's a minimal example:

\name{dummy}
\title{Dummy}
\details{
  The example here is:
\tabular{lcc}{
  Tables   \tab  Are           \tab Cool   \cr
  col 3 is \tab  right-aligned \tab $1600  \cr
  col 2 is \tab  centered      \tab  $12   \cr
 }
}

Note, that the latest {roxygen2} version 7.0 provides more support for markdown-syntax.