CODEWITHSUNDEEP
rmarkdownknitrr-markdown
Jack Tanner
Jack Tanner

Reputation: 934

figure captions, references using knitr and markdown to html

I'm writing an Rmd file, to be processed by knitr into HTML. It contains some R chunks that generate figures, which get stored as data URIs in HTML.

1) How do I add a caption to such an image? I'd like to have a caption that says something like "Figure 3: blah blah blah", where the "3" is automatically generated.

2) How do I later on reference this image, i.e., "as you can see in Figure 3, blah blah".

Upvotes: 37

Views: 28368

Answers (7)

Cucurucho
Cucurucho

Reputation: 71

Using the official bookdown documentation 4.10 Numbered figure captions:

---
output: bookdown::html_document2
---

```{r cars, fig.cap = "An amazing plot"}
plot(cars)
```

```{r mtcars, fig.cap = "Another amazing plot"}
plot(mpg ~ hp, mtcars)
```

Upvotes: 0

Jean-Luc BELLIER
Jean-Luc BELLIER

Reputation: 31

I did both (figure numbers + references) with bookdown. I added in output section in the header of the file:

output:
  bookdown::html_document2:
    fig_caption : TRUE

Then I created a figure in a R code chunk like follows:

{r, my-fig-label,echo=F, eval=T, fig.align = 'center', fig.cap="This is my caption"}
knitr::include_graphics(here::here("images", "my_image.png"))

This produces an automatic number under your figure. You can refer to it with \@ref(fig:my-fig-label).

Upvotes: 1

Ed Hagen
Ed Hagen

Reputation: 409

Another solution:

https://github.com/adletaw/captioner

From the README:

captioner() returns a captioner function for each set of figures, tables, etc. that you want to create. See the help files for more details.

For example:

> fig_nums <- captioner()

> fig_nums("my_pretty_figure", "my pretty figure's caption")

"Figure 1: my pretty figure's caption"

> fig_nums("my_pretty_figure", cite = TRUE)

Upvotes: 3

mikeck
mikeck

Reputation: 3776

I'm late to the party, but I wanted to mention a small package I recently built to do figure captioning and cross-referencing with knitr. It is called kfigr and you can install it using devtools::install_github('mkoohafkan/kfigr'). It is still in active development but the main functionality is there. Be sure to check out the vignette, it shows some usage examples and defines some hooks for figure captions and anchors (I may later choose to have the package import knitr and define those hooks on load).

EDIT: kfigr is now available on CRAN!

Upvotes: 25

user3355146
user3355146

Reputation: 163

Also very late to the party I changed Yihuis suggestion here that he also linked above to do referencing.

```{r functions, include=FALSE}
# A function for captioning and referencing images
fig <- local({
    i <- 0
    ref <- list()
    list(
        cap=function(refName, text) {
            i <<- i + 1
            ref[[refName]] <<- i
            paste("Figure ", i, ": ", text, sep="")
        },
        ref=function(refName) {
            ref[[refName]]
        })
})
```
```{r cars, echo=FALSE, fig.cap=fig$cap("cars", "Here you see some interesting stuff about cars and such.")}
plot(cars)
```

What you always wanted to know about cars is shown in figure `r fig$ref("cars")`

Upvotes: 11

Yihui Xie
Yihui Xie

Reputation: 30104

  1. You can create the figure numbers with a simple counter in R; see one example here. The problem is whether the markdown renderer will render the figure caption for you: R Markdown v1 won't, but v2 (based on Pandoc) will.
  2. I do not know. There is no direct way to insert a label as an identifier for figures, so it is probably not possible to cross reference figures with pure Markdown. Once you've got issues like this, think (1) do I really need it? (2) if it is intended to be a document with a complicated structure, I think it is better to use LaTeX directly (Rnw documents).

Upvotes: 16

Tom
Tom

Reputation: 5052

One way to do both of these is described here: http://rmflight.github.io/posts/2012/10/papersinRmd.html

Another is described here (but I don't know if it does your #2). http://gforge.se/2014/01/fast-track-publishing-using-knitr-part-iii/

Upvotes: 5

Related Questions