Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add exemple for figure caption and references #877

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions inst/examples/02-components.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,22 @@ To take advantage of Markdown formatting _within_ the figure caption, you will n
If you want to cross-reference figures or tables generated from a code chunk, please make sure the chunk label only contains _alphanumeric_ characters (a-z, A-Z, 0-9), slashes (/), or dashes (-).
```

````markdown
Look at figure \@ref(fig:pressure). Isn't it a nice figure ?
Similarly, you can also write about the nice knitr logo (Fig. \@ref(fig:knitref)).

(ref:pressurecap) This is the legend of the figure. Do not forget empty line before and after this legend text.

`r ''````{r pressure, fig.cap='(ref:pressurecap)'}
plot(pressure)
```

(ref:knitrefcap) The knitr logo referenced above.

`r ''````{r knitref, fig.cap='(ref:knitrefcap)'}
knitr::include_graphics("images/knit-logo.png")
```
````

The chunk option `fig.asp` can be used to set the aspect ratio of plots, i.e., the ratio of figure height/width. If the figure width is 6 inches (`fig.width = 6`) and `fig.asp = 0.7`, the figure height will be automatically calculated from `fig.width * fig.asp = 6 * 0.7 = 4.2`. Figure \@ref(fig:pressure-plot) is an example using the chunk options `fig.asp = 0.7`, `fig.width = 6`, and `fig.align = 'center'`, generated from the code below:

Expand Down