convert_ex_to_nb: Convert Exercise To Rmarkdown Notebook

In charlotte-ngs/rteachtools: Tools For Teaching

Convert Exercise To Rmarkdown Notebook

Description

Based on the input of a Rmarkdown source file containing exercise problems and solutions, a Rmarkdown notebook is created that contains only the exercise problems.

Usage

convert_ex_to_nb(
  ps_ex_path,
  ps_nb_out_dir,
  ps_nb_deploy_dir,
  pvec_subdir_nb = c("odg"),
  pn_comment_line_offset = 3,
  pb_force = FALSE,
  pb_debug = FALSE,
  pobj_rtt_logger = NULL
)

Arguments

ps_ex_path	path to the Rmarkdown source file
ps_nb_out_dir	output directory for Rmd notebook
ps_nb_deploy_dir	deployment directory of rendered nb
pn_comment_line_offset	number of lines taken by R-code junk to produce md-comment
pb_force	force output even if output file already exists
pb_debug	debugging flag
pobj_rtt_logger	log4r logger object

Details

This function assumes that the solutions are marked with surrounding R-code junks with the tags comment-start and comment-end.

Examples

## Not run: 
convert_ex_to_nb(ps_ex_path = 'ex/asm_ex02.Rmd',
                 ps_nb_out_dir = 'nb',
                 ps_nb_deploy_dir = 'docs/nb')

## End(Not run)

charlotte-ngs/rteachtools documentation built on Sept. 21, 2023, 4:20 p.m.