deprecated Check the lesson structure for errors

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)
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...
#> ℹ No schedule set, using Rmd files in episodes/ directory.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ────────────────────────────────────────────────────────────────────────
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ℹ To save this configuration, use
#> 
#> set_episodes(path = path, order = ep, write = TRUE)
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ☐ Edit /tmp/RtmplOXhie/file1bc55983688c/episodes/introduction.md.
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ✔ First episode created in /tmp/RtmplOXhie/file1bc55983688c/episodes/introduction.md
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ℹ Workflows up-to-date!
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> ✔ Lesson successfully created in /tmp/RtmplOXhie/file1bc55983688c
#> → Creating Lesson in /tmp/RtmplOXhie/file1bc55983688c...

#> /tmp/RtmplOXhie/file1bc55983688c
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))
#> ! The .gitignore file is missing the following elements:
#> episodes/*html
#> site/*
#> !site/README.md
#> .Rhistory
#> .Rapp.history
#> .RData
#> .Ruserdata
#> *-Ex.R
#> /*.tar.gz
#> /*.Rcheck/
#> .Rproj.user/
#> vignettes/*.html
#> vignettes/*.pdf
#> .httr-oauth
#> *_cache/
#> /cache/
#> *.utf8.md
#> *.knit.md
#> .Renviron
#> docs/
#> po/*~
#> Error in report_validation(checklist, "There were errors with the lesson structure.") : 
#>   There were errors with the lesson structure.

unlink(tmp)