rmdoc-package: rmdoc: rmarkdown documents for software documentation

In bergant/rmdoc: R Markdown Template for Software Documentation

Description

Provides

• R Markdown template

• Functionality to extract data model diagrams from databases

• RStudio AddIn for data model diagrams

Setup

Add connection strings for databases in .Renviron file like this:

RMDOC_CON_STRING_xxxxx=Driver={SQL Server};Server=ssssss;Database=ddddd;Uid=***;Pwd=***

RMDOC_CON_STRING_yyyyy=Driver={SQL Server};Server=eeeeee;Database=aaaaa;Uid=***;Pwd=***

where xxxxx and yyyyyy will be your "logical" database name.

Usage with rmarkdown

Add parameters to your rmd file yaml header (which database is used by default):

params: database: xxxxx

Include the following knitr chunk before your content:

 ```{r database_setup, cache=TRUE}
 if(!is.null(params$database)) {
   .rmdoc_db_meta <- get_db_meta(database = params$database)
   .rmdoc_db_meta_desc <- get_db_meta_desc(database = params$database)
   save(list = c(".rmdoc_db_meta", ".rmdoc_db_meta_desc"), file = "data/db_meta.Rdata")
 }
 ```

Draw graphviz diagrams with display_graph() functions

Draw datamodel diagrams with display_graph(get_graph_from_yaml()) functions

bergant/rmdoc documentation built on May 12, 2019, 3:06 p.m.