deploy_ex: Deploy Exercise

View source: R/deploy.R

deploy_exR Documentation

Deploy Exercise

Description

An parametrized and unified Rmd source file containing both exericse problems and solutions to these problems is rendered two times once to produce a pdf-output that is used as an excercise. The second pdf-output corresponds to the solution to the exercises. This parametrized double-rendering only works, if the solutios do not contain any function calles of knitr::include_graphics() because this function adds a comment after the include statement in the md-output. This causes the commented out solution sections to end. In that case the deployment has to be done with the function deploy_src_to_ex_sol(). In case the Rmarkdown notebook used on the exercise platform (rexpf) is available it is deployed to the target directory where the material for rexpf is stored. The path to the rexpf material is given by the argument ps_rexpf_trg. The Rmarkdown notebook used on rexpf can be produced with the function convert_ex_to_nb().

Usage

deploy_ex(
  ps_ex_path,
  ps_ex_out_dir,
  ps_sol_out_dir,
  ps_rexpf_src = NULL,
  ps_rexpf_trg = NULL,
  pb_debug = FALSE,
  pobj_rtt_logger = NULL
)

Arguments

ps_ex_path

path to the source RMarkdown file

ps_ex_out_dir

directory for exercise output

ps_sol_out_dir

directory for the solution output

ps_rexpf_src

source directory for exercise Rmd file to deploy to rexpf

ps_rexpf_trg

target directory to where exercise Rmd is to be deployed to

pb_debug

flag to determine debugging status

pobj_rtt_logger

log4j logger object

Details

The call to rmarkdown::render() takes the value for the parameters which are used to produce the exercise or the solution document.

Examples

## Not run: 
deploy_ex(ps_ex_path     = 'ex/asm_ex02.Rmd',
          ps_ex_out_dir  = 'docs/ex',
          ps_sol_out_dir = 'docs/sol')

## End(Not run)


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