We define "testing" a tutorial as (successfully) running
render()
on it. This function renders all the tutorials provided in
tutorial_paths
. There is no check to see if the rendered file looks OK.
If a tutorial fails to render, then (we assume!) an error will be generated
which will then filter up to our testing rig.
Examples
knit_tutorials(tutorial_paths = return_tutorial_paths("tutorial.helpers"))
#>
#>
#> processing file: tutorial.Rmd
#> 1/35
#> 2/35 [setup]
#> 3/35
#> 4/35 [copy-code-chunk]
#>
#>
#> processing file: /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/tutorial.helpers/child_documents/copy_button.Rmd
#> 1/3 [change-code]
#> 2/3
#> 3/3 [observe-transfers]
#> 5/35
#> 6/35 [info-section]
#>
#>
#> processing file: /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/tutorial.helpers/child_documents/info_section.Rmd
#> 1/6
#> 2/6 [name]
#> 3/6
#> 4/6 [email]
#> 5/6
#> 6/6 [ID]
#> 7/35
#> 8/35 [exercises-1]
#> 9/35
#> 10/35 [exercises-1-hint-1]
#> 11/35
#> 12/35 [exercises-2]
#> 13/35
#> 14/35 [exercises-2-hint-1]
#> 15/35
#> 16/35 [exercises-3]
#> 17/35
#> 18/35 [exercises-3-hint-1]
#> 19/35
#> 20/35 [unnamed-chunk-1]
#> 21/35
#> 22/35 [exercises-5]
#> 23/35
#> 24/35 [exercises-6]
#> 25/35
#> 26/35 [exercises-7]
#> 27/35
#> 28/35 [exercises-8]
#> 29/35
#> 30/35 [exercises-9]
#> 31/35
#> 32/35 [unnamed-chunk-2]
#> 33/35
#> 34/35 [download-answers]
#>
#>
#> processing file: /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/tutorial.helpers/child_documents/download_answers.Rmd
#> 1/6
#> 2/6 [minutes]
#> 3/6
#> 4/6 [unnamed-chunk-24]
#> 5/6
#> 6/6 [unnamed-chunk-25]
#> 35/35
#> output file: /tmp/Rtmpf0Utnz/tutorial.knit.md
#> /opt/hostedtoolcache/pandoc/3.1.11/x64/pandoc +RTS -K512m -RTS /tmp/Rtmpf0Utnz/tutorial.knit.md --to html4 --from markdown+autolink_bare_uris+tex_math_single_backslash --output /tmp/Rtmpf0Utnz/tutorial.html --lua-filter /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/pagebreak.lua --lua-filter /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/latex-div.lua --variable bs3=TRUE --standalone --section-divs --template /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/rmarkdown/rmd/h/default.html --no-highlight --variable highlightjs=1 --section-divs --reference-location=section --template /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/learnr/rmarkdown/templates/tutorial/resources/tutorial-format.htm --no-highlight --variable highlightjs=1 --variable progressive=true --variable allow-skip=true --variable learnr-version=0.11.5 --id-prefix section- --variable theme=cerulean --mathjax --variable 'mathjax-url=https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' --include-in-header /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/rmarkdown/rmd/h/shiny-header.html
#>
#> Output created: /tmp/Rtmpf0Utnz/tutorial.html
#> -- Skip: Rendering /home/runner/.cache/R/renv/library/tutorial.helpers-cdd4ef10/linux-ubuntu-jammy/R-4.4/x86_64-pc-linux-gnu/tutorial.helpers/tutorials/getting-started/tutorial.Rmd --
#> Reason: empty test
#>
#> NULL