Floats

Full-width figures

Use a fenced Div with the class fullwidth, e.g.,

::: {.fullwidth}
Any Markdown content or code blocks here.

```{r, echo=FALSE, fig.dim=c(14, 4)}
plot(sunspots)
```
:::
Monthly mean relative sunspot numbers from 1749 to 1983. Collected at Swiss Federal Observatory, Zurich until 1960, then Tokyo Astronomical Observatory.

Figure 1: Monthly mean relative sunspot numbers from 1749 to 1983. Collected at Swiss Federal Observatory, Zurich until 1960, then Tokyo Astronomical Observatory.

If you add the class fullscroll to the Div, the figure will be scrollable, e.g.,

::: {.fullwidth .fullscroll}

:::
This is a super wide figure that you need to scroll to view it fully.

Figure 2: This is a super wide figure that you need to scroll to view it fully.

Embedded figures

You can embed any elements (typically figures) that span into the page margin. Use a fenced Div with the class embed-left or embed-right, e.g.,

This is a figure embedded on the right.

Figure 3: This is a figure embedded on the right.

::: {.embed-right}

Here is a special figure.

```{r}
plot(cars)
```
:::

If you want to embed a table, that will be okay, too. Really, you can embed anything.

::: {.embed-left}
```{r, echo=FALSE}
knitr::kable(head(mtcars), caption = 'An example dataset.')
```
:::
Table 1: An example dataset.
mpg cyl disp hp drat wt qsec vs am gear carb
Mazda RX4 21.0 6 160 110 3.90 2.620 16.46 0 1 4 4
Mazda RX4 Wag 21.0 6 160 110 3.90 2.875 17.02 0 1 4 4
Datsun 710 22.8 4 108 93 3.85 2.320 18.61 1 1 4 1
Hornet 4 Drive 21.4 6 258 110 3.08 3.215 19.44 1 0 3 1
Hornet Sportabout 18.7 8 360 175 3.15 3.440 17.02 0 0 3 2
Valiant 18.1 6 225 105 2.76 3.460 20.22 1 0 3 1

Now I have generate some text to fill the space on the right: hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer hold my beer.

Text elements

Table of contents

TOC should be automatically generated unless it is disabled via features: [-toc] in YAML. To define the TOC title, use the toc-title field in YAML.

Section numbers

Sections should be automatically numbered unless Pandoc has already numbered them,1 or the feature is disabled via features: [-number_sections].

Footnotes

Footnotes should be automatically moved to the right margin,2 unless the feature is disabled via features: [-sidenotes].

Sidenotes

Sidenotes can be generated via a div with classes side and side-left or side-right. You can use either the HTML syntax <div class="side side-left"> or Pandoc’s fenced Div, e.g.,

This is a sidenote on the right side when the window is wider than 1280px.

::: {.side .side-right}
This is a **sidenote** on the right.
:::

Citations

Use bibliography or references in YAML to include the bibliography database, and use @ to cite items, e.g., @R-base generates R Core Team (2020).

knitr::write_bib('base', 'packages.bib')

As you can see above, we generated a .bib database with knitr::write_bib().

Citation entries are displayed in the right margin by default like footnotes. To disable this behavior, set features: [-sidenotes] in YAML.

R Core Team. 2020. R: A Language and Environment for Statistical Computing. Vienna, Austria: R Foundation for Statistical Computing. https://www.R-project.org/.

  1. Apply the option number_sections: true to the output format blogdown::html_page in YAML.↩︎

  2. For example, this is a footnote.↩︎

Author's bio

Yihui Xie (https://yihui.org) is a software engineer at RStudio. He earned his PhD from the Department of Statistics, Iowa State University. He has authored several R packages, such as knitr, bookdown, blogdown, xaringan, DT, and tinytex. He also co-authored a few other R packages, including shiny, rmarkdown, and leaflet. He has published a number of books, including Dynamic Documents with R and knitr, bookdown: Authoring Books and Technical Documents with R Markdown, blogdown: Creating Websites with R Markdown, R Markdown: The Definitive Guide, and R Markdown Cookbook. He is the founder of the Capital of Statistics (https://cosx.org). He initiated the Chinese R conference in 2008.

Reuse

Text and figures are licensed under Creative Commons Attribution CC BY 4.0. The source code is licensed under MIT. The full source is available at https://github.com/yihui/hugo-prose.

Suggest changes

If you find any mistakes (including typos) or want to suggest changes, please feel free to edit the source file of this page on Github and create a pull request.

Citation

For attribution, please cite this work as

Yihui Xie (2020). R Markdown Demo. Hugo Prose. https://prose.yihui.org/post/2020/11/10/r-markdown-demo/

BibTeX citation

@misc{
  title = "R Markdown Demo",
  author = "Yihui Xie",
  year = "2020",
  journal = "Hugo Prose",
  note = "https://prose.yihui.org/post/2020/11/10/r-markdown-demo/"
}