check_fm: Check front-matter.yml

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

Check front-matter.yml

Description

Checks for existence of front-matter.yml in the meta/ subfolder of supplied working directory. Then, validates that certain expected parameters are set

Usage

check_fm(WD = "?", skip = NULL, throw_error = TRUE)

Arguments

WD	working directory; default= getwd(); if "?" supplied, will invoke pick_lesson()
skip	a character vector of items you want to skip validation for. default=NULL. Options: locale: Check for existence of locale entry in front-matter.yml gh: Check for existence of GitHubURL entry in front-matter.yml
throw_error	logical; Do you want to stop code if error (T) or just throw a warning (F)? default=T

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