figure captions, references using knitr and markdown to html

Question

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".

Solution 1

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).

Solution 2

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!

Solution 3

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")`

Solution 4

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/

Solution 5

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)

View more solutions

Comments

[Max Gordon]

Since the new rmarkdown the workflow in my post needs to be changed, I've currently implemented a few simple functions that do the job for adding a figure counter - even though it is not as elegant as before. The functions are present in the Gmisc-package and are figCapNo, figCapNoLast, and figCapNoNext- see how to use it int the documentation for the first figCapNo.

[mikeck]

It looks like kfigr will become obsolete soon as bookdown is in beta testing: bookdown.org/yihui/bookdown. I encourage folks to try bookdown as kfigr does not always play nice with pandoc and doesn't support markdown-->PDF.

[woshishui]

Thanks @user3355146. The only issue is the fig$ref() can only be called after the figure was generated, i.e. Figure r fig$ref("cars") BELOW shows... etc etc. is not going to work. But still a very nice solution to solve my problem. thanks,