compileB2D: Compile bookdown formatted markdown to a Dodona-ready format

In statOmics/bookdown2dodona: Compile bookdown formatted markdown to a Dodona-ready format

Description

The compileB2D function can be used to compile a set of Rmarkdown files that follow the bookdown standard to a folder structure of description files that can be directly used with Dodona.

Usage

compileB2D(
  source_dir = ".",
  output_dir = "./dodona_md",
  book_dir = "book_md",
  language = "nl",
  split_level = 2,
  continue_str = "Vervolg",
  config_file = "_bookdown.yml"
)

Arguments

source_dir	(optional) Path to the directory containing the bookdown source files. Default is current working directory.
output_dir	(optional) Path to the directory where the Dodona file structure will be saved. Default is './dodona_md'
book_dir	(optional) Name of the directory where the complete book will be saved as an .md file. This directory will be placed in the source directory. Default is 'book_md'
language	(optional) Language identifier string that is used to tell Dodona which language the descriptions are in. Default is 'nl'.
split_level	(optional) Level of markdown headers at which chapters will be split in Dodona reading assignments. Default is 2, corresponding to '##' headers.
continue_str	(optional) String that is used to indicate the continuation of a chapter when section breaks (<!–break–>) are used. Default is 'Vervolg'.
config_file	(optional) Name of the configuration file used by bookdown. Default is '_bookdown.yml'

Examples

#compileB2D()
#compileB2D('./myBookdownProject', output_dir='myDodonaBook', book_dir='myFullBook')

statOmics/bookdown2dodona documentation built on Oct. 7, 2021, 4:52 p.m.