batch_compile: batch 'compile_lesson()'

View source: R/batch_compile.R

batch_compileR Documentation

batch compile_lesson()

Description

Function to rebuild a lesson or lessons that found in a virtualized Google Drive for Desktop folder. It will also stage the lesson in the published folder if requested, but will not publish. To do that, you should call batch_publish()

Usage

batch_compile(
  shared_drive = "s",
  change_this = NULL,
  clean = FALSE,
  rebuild = FALSE
)

Arguments

shared_drive

passed to pick_lesson() which shared drive do you want to find the lessons in? default= "s" Options:

  • "s" or "?" = GP-Studio (draft working directory, many users with access)

  • "l" or "??" = GP-Live (private, admin only)

change_this

A list of values to change in the front matter before rebuilding. Default=NULL. Example: list(Title="Stormy Misty's Foal") would change the title of the lesson to the name of a horsey novel. If gh_proj_name=="all", make sure you set this to something you want to change for everything.

clean

Do you want to clean the meta/JSON folder and build everything from scratch? (Gets passed to compile_lesson()). Default=FALSE

rebuild

Do you want to force rebuild everything (even if a particular item seems up to date?) default=FALSE (This par gets passed on as rebuild to compile_lesson())

Details

This assumes that you have Google Drive for Desktop set up and have permissions to access the lesson files.


galacticpolymath/GPpub documentation built on April 5, 2025, 6:04 p.m.