Skip to contents

Finding things

Identifying lectures, finding slides, and checking things are the way they need to be.

lectures()
Get included lectures
collect_lectures()
Assemble table of lecture slides
find_slide_tex()
Find a slide set across all lectures
check_system_tool()
Simple check for availability of system tools
check_docker()
Check if docker can be used

Compilation and checking

Compile slides with either latexmk or TinyTeX, and check them against the reference files in slides-pdf.

check_slides_single()
Compile and compare a slide chunk
check_slides_many()
Compile and compare many slides
compile_slide()
Compile a single .tex file
compare_slide()
Compare slide PDF against reference PDF
clean_slide()
Clean output for a single .tex file
latexmk_docker()
Run dockerized latexmk
latexmk_system()
Run latexmk
latexmk_tinytex()
Run TinyTex's latexmk

Figure script auditing

Audit the script-figure-slide dependency chain within lecture chapters.

audit_chapter()
Audit the script-figure-slide dependency chain for a chapter
clean_orphaned_figures()
Remove orphaned figures from a chapter
render_chapter_audit()
Render a chapter audit report
run_chapter_scripts()
Run all scripts in a chapter and track produced figures
run_script()
Run an R script in an isolated subprocess
parse_slide_figures()
Parse figure references from a LaTeX slide file
extract_script_deps()
Extract package dependencies from R scripts
check_script_deps()
Check and install missing dependencies for chapter scripts
check_lecture_deps()
Check and install missing dependencies for all chapter scripts

Slide status reporting

Render slide status reports and manage the slide check cache.

render_slide_status()
Render the slide status HTML report
render_slide_status_pr()
Render the slide status PR markdown table
slide_cache_path()
Get the path to the slide check cache file
slide_cache_clean()
Delete the slide check cache

Utilities

Various helper functions

check_log()
Check latexmk logs for common errors
bib_to_list()
Convert bib file to formatted list for Markdown output
install_lecheck()
Install the lecheck cli tool
set_margin_token_file()
Manage the with/without margin dummy file
repo_status()
Lecture repo status
this_repo_status()
Service repo checkout status