makeHarmonizationBook: Make a R markdown book

Description Usage Arguments

View source: R/makeHarmonizationBook.R

Description

Get the variables from a Opal table and dump a book of R markdown templates, ready for the including derivation code chunks and harmonization status.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
makeHarmonizationBook(
  opal,
  project,
  table,
  taxonomy = "Mlstr_area",
  vocabularies = NULL,
  locale = "en",
  outDir = file.path(getwd(), "_harmobook"),
  outFiles = list(domains = "04-domains.Rmd", index = "06-index.Rmd")
)

Arguments

opal

Opal connection object.

project

Project name where the table is located.

table

Table name from which the data dictionary should be extracted.

taxonomy

Taxonomy name to group variables by vocabularies and terms.

vocabularies

Vocabularies that shall be included, default is all (NULL value).

locale

The locale in which the labels should be extracted (default is "en").

outDir

Output folder where the R markdown files will be produced (default is '_harmobook' folder in the current working directory). Also used to find R markdown templates (in the '_templates' subfolder); if non is found the 'harmor' package default ones will be used.

outFiles

Names of the output files, idenitified by "domains" or "index".


maelstrom-research/harmor documentation built on Dec. 6, 2019, 7:31 p.m.