Creating accessible & reproducible teaching materials with minimum scaffolding

Clement Lee (Newcastle University)

2024-06-14

Outline

From old-fashioned teaching materials
- verbatim R code & output in .tex
- auxiliary files: .pdf, .png, …
- R scripts for generating the auxiliary files
- by products: .out, .log, .aux, …
To accessible & reproducible materials
- ~~separate R scripts~~
- {html, pdf} $\times$ {solutions, questions/gaps}
Aggregation of marginal gains (Kaizen)
Manual but efficient workflow
- Focus on future savings
- Script-based, good for version control
- As little scaffolding as possible
What works and what doesn’t
~~R Markdown tutorial~~

Slides: https://bit.ly/ukcots2024

Github repo: https://bit.ly/template-repo

Starting point

The source file (.tex)

\documentclass[a4paper]{article}
\usepackage{amsmath}
\title{MATH9999 Practical 1 Questions}
\date{2024-06-14}

\begin{document}
\maketitle
\noindent
\begin{enumerate}
  \item Plot the \texttt{cars} dataset in \verb^R^. 







  \item Find the numerical value of $2\pi$, to $4$ decimal places.





  \item Show that $e^{i\pi}+1=0$.








\end{enumerate}


% A comment that won't appear in the output.

\end{document}

The output (.pdf)

MATH9999 Practical 1 Questions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
Show that $e^{i\pi}+1=0$.

A separate solution file

The source file (.tex)

\documentclass[a4paper]{article}
\usepackage{amsmath,graphicx,enumitem}
\title{MATH9999 Practical 1 Solutions}
\date{2024-06-14}

\begin{document}
\maketitle
\noindent
\begin{enumerate}
  \item Plot the \texttt{cars} dataset in \verb^R^. 
  \begin{verbatim}
  plot(cars)
  \end{verbatim}
  \begin{center}  
  \includegraphics[width=\textwidth]{cars.pdf} 
  \end{center}

  \item Find the numerical value of $2\pi$, to $4$ decimal places.
  \begin{verbatim}
    
  round(2 * pi, 4)
  ## [1] 6.2832
  \end{verbatim}
  \item Show that $e^{i\pi}+1=0$.




  \begin{align*}
  e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
  &=-1+i\times0+1=0
  \end{align*}  
\end{enumerate}


% A comment that won't appear in the output.

\end{document}

The output (.pdf)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

1. Reproducibility / dynamic generation

The source file (.Rnw)

\documentclass[a4paper]{article}
\usepackage{amsmath,graphicx,enumitem}
\title{MATH9999 Practical 1 Solutions}
\date{2024-06-14}

\begin{document}
\maketitle
\noindent
\begin{enumerate}
  \item Plot the \texttt{cars} dataset in \verb^R^. 
  <<cars>>=

  plot(cars)
  @



  \item Find the numerical value of $2\pi$, to $4$ decimal places.
  <<two-pi>>=

  round(2 * pi, 4)
  @

  \item Show that $e^{i\pi}+1=0$.




  \begin{align*}
  e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
  &=-1+i\times0+1=0
  \end{align*}
\end{enumerate}


% A comment that won't appear in the output.

\end{document}

The output (.pdf)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

2. R Sweave to R Markdown

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 Solutions"
date: "2024-06-14"
output: pdf_document


---

1. Plot the `cars` dataset in `R`. 
```{r cars}

plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}

round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.pdf)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

2. (cont’d)

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 Solutions"
date: "2024-06-14"
output: html_document


---

1. Plot the `cars` dataset in `R`. 
```{r cars}

plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}

round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

3. Toggle for questions & solutions

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 Solutions"
date: "2024-06-14"
output: html_document


---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: true
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: true
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

3. (cont’d)

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 Solutions"
date: "2024-06-14"
output: html_document


---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: false
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: false
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

4. Parametrise the toggle

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: html_document
params:
  solution: false
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Questions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

4. (cont’d)

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: html_document
params:
  solution: true
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.




\begin{align*}
e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
&=-1+i\times0+1=0
\end{align*}



<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

5. Hack the non-coding questions

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: html_document
params:
  solution: true
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
round(2 * pi, 4)
```
```
## [1] 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

5. (cont’d)

The source file (.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: html_document
params:
  solution: false
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Questions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
Show that $e^{i\pi}+1=0$.

\[~\] \[~\] \[~\]

https://xkcd.com/1638/

6. Externalise the parameters

The source file (Practical1.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The R command

rmarkdown::render(
  "Practical1.Rmd", params = list(solution = FALSE),
  output_format = "html_document",
  output_file = "Practical1_questions.html"
)

\[~\] \[~\] \[\Downarrow\Downarrow\Downarrow\] \[~\] \[~\]

The output (Practical1_questions.html)

MATH9999 Practical 1 Questions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
$~~~$Show that $e^{i\pi}+1=0$.

6. (cont’d)

The source file (Practical1.Rmd)

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The R command

rmarkdown::render(
  "Practical1.Rmd", params = list(solution = FALSE),
  output_format = "pdf_document",
  output_file = "Practical1_questions.pdf"
)

\[~\] \[~\] \[\Downarrow\Downarrow\Downarrow\] \[~\] \[~\]

The output (Practical1_questions.pdf)

MATH9999 Practical 1 Questions
2024-06-14

Plot the cars dataset in R.
Find the numerical value of $2\pi$, to $4$ decimal places.
$~~~$Show that $e^{i\pi}+1=0$.

7. Bringing it all together

Practical1.Rmd

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The R script

library(rmarkdown)
render(
  "Practical1.Rmd", params = list(solution = FALSE),
  output_format = "pdf_document",
  output_file = "Practical1_questions.pdf"
)
render(
  "Practical1.Rmd", params = list(solution = FALSE),
  output_format = "html_document",
  output_file = "Practical1_questions.html"
)
render(
  "Practical1.Rmd", params = list(solution = TRUE),
  output_format = "pdf_document",
  output_file = "Practical1_solutions.pdf"
)
render(
  "Practical1.Rmd", params = list(solution = TRUE),
  output_format = "html_document",
  output_file = "Practical1_solutions.html"
)

The outputs

Practical1_questions.pdf
Practical1_questions.html
Practical1_solutions.pdf
Practical1_solutions.html

Variant A: Language agnostic(-ish)

Practical1.Rmd

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{python two-pi}
#| include: !expr params$solution
import math
round(2 * math.pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The output (.html)

MATH9999 Practical 1 Solutions
2024-06-14

Plot the cars dataset in R.
```
plot(cars)
```
Find the numerical value of $2\pi$, to $4$ decimal places.
```
import math
round(2 * math.pi, 4)
```
```
## 6.2832
```
$~~~$Show that $e^{i\pi}+1=0$. \[\begin{align*} e^{i\pi}+1&=\cos\pi+i\sin\pi+1\qquad\qquad\qquad\qquad\\ &=-1+i\times0+1=0 \end{align*}\]

Variant B: Slides

Lecture1.Rmd

---
classoption: a4paper
title: "MATH9999 Lecture 1 `r if (params$solution) 'Complete' else 'Gaps'` version"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

## Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



## Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

## Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

The R script

library(rmarkdown)
render(
  "Lecture1.Rmd", params = list(solution = FALSE),
  output_format = "pdf_document",
  output_file = "Lecture1_gaps.pdf"
)
render(
  "Lecture1.Rmd", params = list(solution = FALSE),
  output_format = "html_document",
  output_file = "Lecture1_gaps.html"
)
render(
  "Lecture1.Rmd", params = list(solution = TRUE),
  output_format = "pdf_document",
  output_file = "Lecture1_complete.pdf"
)
render(
  "Lecture1.Rmd", params = list(solution = TRUE),
  output_format = "html_document",
  output_file = "Lecture1_complete.html"
)

The outputs

Lecture1_gaps.pdf
Lecture1_gaps.html
Lecture1_complete.pdf
Lecture1_complete.html

Upgrade: whole set of notes

01-preliminaries.Rmd

# Preliminaries








## Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



## Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

## Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

02-intermediate.Rmd, 03-advanced.Rmd, …

index.Rmd

---
title: "MATH9999"
date: Semester 2, 2023/2024  
output: ""
documentclass: book
papersize: a4
geometry:
- margin=1in
fontsize: 12pt
bibliography: [references.bib]
biblio-style: apalike
link-citations: yes
params:
  solution: ""
---

The R script

library(bookdown)
render_book(
  "index.Rmd", param = list(solution = FALSE), # TRUE for complete version
  output_format = c("bookdown::gitbook", "bookdown::pdf_book")
)

The outputs

A single pdf
A set of webpages

What about LaTeX environments & commands?

Some work

equation
align
aligned
eqnarray
array
(and their * versions)
$$ $$
\[ \]

Some don’t (for HTML)

center
tabular
displaymath
\intertext
\textcolor
\medskip
\bigskip
\hfill
\newpage

Some have been taken care of

enumerate: (R) Markdown can do lists
itemize: (R) Markdown can do lists
quote: (R) Markdown can do quotes
solution: The hack using strings in R
verbatim: Backticks ``
example: Environment extended by bookdown
exercise: Environment extended by bookdown
figure: Function knitr::include_graphics()

We’ve come a long way

Practical1_solutions.tex

\documentclass[a4paper]{article}
\usepackage{amsmath,graphicx,enumitem}
\title{MATH9999 Practical 1 Solutions}
\date{2024-06-14}

\begin{document}
\maketitle
\noindent
\begin{enumerate}
  \item Plot the \texttt{cars} dataset in \verb^R^. 
  \begin{verbatim}
  plot(cars)
  \end{verbatim}
  \begin{center}  
  \includegraphics[width=\textwidth]{cars.pdf} 
  \end{center}

  \item Find the numerical value of $2\pi$, to $4$ decimal places.
  \begin{verbatim}
    
  round(2 * pi, 4)
  ## [1] 6.2832
  \end{verbatim}
  \item Show that $e^{i\pi}+1=0$.




  \begin{align*}
  e^{i\pi}+1&=\cos\pi+i\sin\pi+1\\
  &=-1+i\times0+1=0
  \end{align*}  
\end{enumerate}


% A comment that won't appear in the output.
\end{document}

And Practical1_questions.tex and some auxiliary files

Practical1.Rmd

---
classoption: a4paper
title: "MATH9999 Practical 1 `r if (params$solution) 'Solutions' else 'Questions'`"
date: "2024-06-14"
output: ""
params:
  solution: ""
---

1. Plot the `cars` dataset in `R`. 
```{r cars}
#| include: !expr params$solution
plot(cars)
```



2. Find the numerical value of $2\pi$, to $4$ decimal places.
```{r two-pi}
#| include: !expr params$solution
round(2 * pi, 4)
```

3. Show that $e^{i\pi}+1=0$.
```{r euler}
#| include: !expr params$solution
#| results: "asis"
#| echo: false
string0 <- "\\begin{align*}
e^{i\\pi}+1&=\\cos\\pi+i\\sin\\pi+1\\\\
&=-1+i\\times0+1=0
\\end{align*}"
cat(string0, "\n")
```

<!-- A comment that won't appear in the output. -->

And the R script / makefile

Tasks when converting

Edit the preamble
Move \label{} outside (sub)(sub)section headings
Replacements with regular expressions (regex)
Replacements with strings
Remove some LaTeX commands: \textcolor, \medskip, \bigskip, \hfill, \newpage, \intertext
Edit section & equation labels & \eqref{}
Edit “other” environments in conjunction with their labels
Edit itemize & enumerate environments
Convert environments to R code chunks:
- solution: the string hack
- figure: knitr::include_graphics() (& convert .pdf to .png)
- verbatim: actual R code without hardcoded results
- tabular: knitr::kable() (or markdown syntax for tables)
Fix code chunk labels ("_" $\rightarrow$ “-”) & options: dev, out.width
Add space in solution code chunks for PDF version, in conjunction with figure positions

Replacements (in this order)

Before	After	Remarks
`\label{([^}]+)_([^}]+)_([^}]+)}`	`{#\1-\2-\3}`	Similar for those with fewer "_"
`\ref{([^}]+)_([^}]+)_([^}]+)}`	`\@ref(\1-\2-\3)`	Ditto
`\section{([^}]+)}`	`## \1`	One # fewer for single document
`\section*{([^}]+)}`	`## \1 {-}`	Ditto; similar for (sub)(sub)sections
`\textit{([^}]+)}`	`\1`	Same for `\emph{([^}]+)}`
`\textbf{([^}]+)}`	`\1`
`\texttt{([^}]+)}`	`\1`	Same for `\verb`
`\Sexpr{([^}]+)}`	`r \1`
`\footnote{([^}]+)}`	`^[\1]`
` `(.*)''	`"\1"`	Before below replacments with `
`^<<>>=$`	```{r}
`^<<(.*)>>=`	```{r, \1}
`^@[\s]?`	```
`^%(.*)`	`<!-- \1 -->`	After fixing environments commented out
(self-defined LaTeX commands)	(Markdown replacements)	(or just original LaTeX commands)

Figure~	Figure	Not regex; with space at the end;
		same for Chapter, Section, etc.
`\_`	`_`	Not regex; same for `\$`, `\%` and `\&`

Scaffolding

R(Studio)
Package rmarkdown (all lowercase)
- For standalone documents & whole set of notes
Package bookdown
- Only required for whole set of notes
Packages specific for your module
- Most likely in the R script
Package tinytex (recommended)
- For below
LaTeX distribution & TeX packages
- installed within R via tinytex::install_tinytex()
- tinytex::tlmgr_install() useful
Package reticulate & Python (3)
- For Python content

YMMV: Even though they are meant for reproducibility
E.g. Labelling & referencing that works in bookdown doesn’t automatically work in R Markdown

Summary

.tex $\rightarrow$ .Rmd
- Results generated dynamically via code chunks
- Non-coding questions: hack using strings
- Parametrised toggle in preamble
Additional R script / makefile
- {.pdf, .html} $\times$ {question, solutions}
- Parametrised toggle in the script
Variants & upgrade
- Python content
- Slides
- Whole set of notes (bookdown)
Conversion considerations
- A standard set of tasks, but manual work required
- Time saved by regex & string replacements

Benefits?

Check the accessibility box
- Even if not perfect the first time
- html embedded in the VLE
Less to change next time
- Instead of updating 2 .tex files, which might not match over time
No need to do everything in one go
- Steps (almost) orthogonal
Script-based approach
- Version control straightforward
Preach what you practise
- Ask students to write assignments using R Markdown
- Also write the assignments questions / solutions in the same way

Thank you!

Slides: https://bit.ly/ukcots2024

Github repo: https://bit.ly/template-repo