\(\definecolor{frog}{rgb}{1,0,0}\) \(\newcommand{\dx}{\,\text{d}x}\) \(\newcommand{\du}{\,\text{d}u}\) \(\newcommand{\dy}{\,\text{d}y}\) \(\newcommand{\dt}{\,\text{d}t}\)
This chapter shows off some nice coloured boxes. They come from the custom-numbered-blocks extension. First you need to install the extension quarto add ute/custom-numbered-blocks.
The following colour definitions need to be added somewhere (e.g. _quarto.yml or _metadata.yml or at the top of this .qmd file) to load the coloured boxes. In this template I have added a link to a file called _numbered-boxes.yml from inside _quarto.yml. In this way you just need to look insider _numbered-boxes.yml to edit the settings.
It looks approximately like this, you define groups of like-numbered boxes, and then define specific classes (and their names later). They can have separate colour schemes too.
filters:
- custom-numbered-blocks # This loads the extension
# This is ute-hahn's nice coloured boxes: setup
custom-numbered-blocks:
groups:
thmlike:
colors: [948bde, 584eab]
boxstyle: foldbox.simple
deflike:
colors: [ffdc36, ffb948]
boxstyle: foldbox.simple
videolike:
colors: [beb9eb, 877eda]
boxstyle: foldbox.simple
collapse: open
classes:
Theorem:
group: thmlike
Lemma:
group: thmlike
Corollary:
group: thmlike
Definition:
group: deflike
Video:
group: videolike
crossref:
chapters: trueWe’ve defined several custom-numbered block types using the custom-numbered-blocks option. The key point is that these can be numbered and follow grouped numbering conventions.
Each block belongs to a group that determines its shared numbering.
All of these blocks are foldable, meaning they can be opened and closed. The collapse setting determines the starting state. Most boxes have been set to be open (collapse: false) at the group level, but this can be overridden at both lower levels. e.g. Corollary shares numbering with all the theorem-like boxes, which are all open by default. Corollaries could be all set to closed by default, or even on a case by case basis in the code.
| Box Name | Group | Title Background Color | Left Border Color | Default State |
|---|---|---|---|---|
| Theorem | thmlike |
#948bde |
#584eab |
Open / Closeable |
| Lemma | thmlike |
#b2dac4 |
#004721 |
Open / Closeable |
| Corollary | thmlike |
#7fbad7 |
#005398 |
Open / Closeable |
| Definition | deflike |
#ffdc36 |
#ffb948 |
Open / Closeable |
| Video | videolike |
#d18888 |
#660000 |
Closed / Openable |
These boxes also have dark-mode versions, see below. Notice this table had a caption, and it can be referenced with normal Quarto syntax: Table 4.1. They can also have styling added.
Note: The two colors defined for each group represent the left border and the title background.
Here’s an alternative to treating videos as float/figures, just stick them directly onto the page immediately (not as a floating object) but wrap them in a coloured box and use the title of the box to describe the video.
Here’s some famous beetle data. The R code is folded (and thus hideable), the Python code isn’t folded so cannot be folded away.
beetles <- read.csv(url("http://www.stats.gla.ac.uk/~tereza/rp/beetles.csv"))
beetles dose number killed
1 1.6907 59 6
2 1.7242 60 13
3 1.7552 62 18
4 1.7842 56 28
5 1.8113 63 52
6 1.8369 59 53
7 1.8610 62 61
8 1.8839 60 60import pandas as pd
beetles = pd.read_csv("../resources/data/beetles.csv")
beetlesSome content
There are no Corollary’s better than Corollary 1. Note that referencing of these coloured boxes works like LaTeX’s \ref{} command, thus it just renders the number, and you have to write the object name in front. This is in contrast to the @cor-name Quarto notation.
Full documentation on these coloured boxes is available at https://github.com/ute/custom-numbered-blocks. Including the new \longref{} syntax allowing the object name to be included in the reference. Like this Corollary 1.
The other way to embed a video is inside a fenced div and treat it like a figure, as we saw in other chapters.
Our video in this chapter was embedded inside a custom numbered block and it was called Video 1, in a moment we’ll include another video. It will be called Video 2.
Below are examples of the custom-numbered blocks.
Each block is foldable (open or closed by default) and has its own colour scheme and group style as defined in your YAML configuration.
Notice Theorem, Corollary and Lemma has been defined to share a counter. Unlike Video and Definition which are different types (vidlike and deflike).
You can reference the blocks defined above using their labels:
If we want we can wrap the \ref{} inside a hyperlink to get Theorem 2, Corollary 3, etc…
Update: The custom-numbered-blocks extension now offers \longref{} as a way to make the hyperlink include the word of the type of object, like \longref{rthmpythag} now rendering as Theorem 2.
Each box’s definition uses two colours. In the file mentioned above the light-mode border and background are set. For those using dark-mode you also need to define a dark mode pair (so you’ll need four total colours). See dark styles boxes stylesheet for how to define them as it’s not available as a default setting.
Rendering documents containing R and Python is based on the reticulate and knitr R packages.
One way is to let Quarto manage a Python environment for you via quarto install python, but if you already have Python installed, the recommended approach now is to use a persistent virtual environment.
Look at the top of this file and you’ll find a chunk like this
```{r}
#| label: reticulate-setup
#| include: false
library(reticulate)
# These next two lines need to run ONCE on your machine to create the environment
# reticulate::virtualenv_create("r-quarto")
# reticulate::py_install(c("pandas","seaborn","matplotlib","numpy"), envname = "r-quarto")
# Use the virtual environment in this document
reticulate::use_virtualenv("r-quarto", required = TRUE)
```virtualenv_create and py_install lines to set up the environment.use_virtualenv line is needed.The advantage of this approach is that libraries are installed once and persist across sessions, so you don’t incur installation overhead every time you render the document.
If while developing your notes you realize you need to load another library, then re-run the py_install line to install this library into your r-quarto environment, e.g. by running these lines in the console:
library(reticulate)
reticulate::py_install(c("insert-new-library-here"), envname = "r-quarto")Once the environment is set, you can run Python chunks as usual:
This will demonstrate the R/Python switcher again. Notice this page doesn’t contain the global toggle button in the bottom left as it was disabled in the _metadata.yml file in this folder, should you wish to disable it.
x <- rnorm(50)
plot(x)
import numpy as np
import matplotlib.pyplot as plt
r = np.arange(0, 2, 0.01)
theta = 2 * np.pi * r
fig, ax = plt.subplots(
subplot_kw = {'projection': 'polar'}
)
ax.plot(theta, r)
ax.set_rticks([0.5, 1, 1.5, 2])
ax.grid(True)
plt.show()x <- seq(-10,10, by = 0.1)
y <- x ^ 3
plot(x, y, type = "l")
import matplotlib.pyplot as plt
import numpy as np
xpoints = np.arange(-10, 10, 0.1)
ypoints = np.power(xpoints, 3)
plt.plot(xpoints, ypoints)
plt.show()The output images from these pieces of code have their own labels namely @fig-rnorm and @fig-polar which reference as Figure 4.1 and ?@fig-polar.