check_lesson: deprecated Check the lesson structure for errors
In carpentries/sandpaper: Create and Curate Carpentries Lessons

check_lesson

R Documentation

deprecated Check the lesson structure for errors

Description

This function is now deprecated in favour of validate_lesson().

Usage

check_lesson(path = ".", quiet = TRUE)

Arguments

`path`	the path to your lesson
`quiet`	if quiet (default TRUE) then no info messages printed to stdout

Value

TRUE (invisibly) if the lesson is cromulent, otherwise, it will error with a list of things to fix.

Examples


# Everything should work out of the box
tmp <- tempfile()
create_lesson(tmp, open = FALSE, rmd = FALSE)
check_lesson(tmp)

# if things do not work, then an error is thrown with information about
# what has failed you
unlink(file.path(tmp, ".gitignore"))
unlink(file.path(tmp, "site"), recursive = TRUE)
try(check_lesson(tmp))

unlink(tmp)

carpentries/sandpaper documentation built on July 17, 2025, 12:01 a.m.