Highlighting

Highlight lines or spans of code or line blocks.

Closeread enables the highlighting of both code and text using a similar syntax.

To highlight particular lines of code for your reader, you can add an attribute to your trigger called highlight. To highlight lines of code, you can either use a series of line numbers separated by commas or a range separate by a hyphen. Some examples:

• highlight="1,5": highlight lines 1 and 5
• highlight="1-5": highlight lines 1 through 5

The following section demonstrates that functionality. Note that all stickies use .scale-to-fill

We’ll show an example that demonstrates the use of the dplyr R package for data wrangling.

Here is a dplyr pipeline that processes a data frame containing information on Antarctic penguins.

In the first two lines we load the dplyr package and the palmerpenguins package, which contains the data frame.

The main block of code is referred as a pipeline or chain. Each line starts with a function and ends with a pipe, |>.

library(dplyr)
library(palmerpenguins)

penguins |>
  filter(year == 2008) |>
  group_by(species) |>
  summarize(avg_bill_length = mean(bill_length_mm)) |>
  arrange(avg_bill_length)

# A tibble: 3 × 2
  species   avg_bill_length
  <fct>               <dbl>
1 Adelie               38.6
2 Gentoo               46.9
3 Chinstrap            48.7

The syntax for a lineblock (like a poem) is the same, with one addition.

• highlight="cr-myspan": highlight particular span within a lineblock

The limerick is a form of poetry composed of five lines.

Here is the first limerick appearing in the written record, from the Saint John Daily News in 1880.

The end of the first two lines of a Limerick must rhyme.

The end of the third and fourth line also rhyme and are nudged in a bit.

There was a young rustic named Mallory,
who drew but a very small salary.
  When he went to the show,
  his purse made him go
to a seat in the uppermost gallery.