captioner is an R package for generating figure numbers and captions
Current version: Betadiversity 2.1 (4 February 2015). Display the figure number with no surrounding text (e.g "1").
Previous version: Betadiversity 2.0 (30 January 2015). Hierarchical numbering (e.g. Figure 1.1).
Installation
the subdirectory captioner contains the package files
to install:
install.packages("devtools")devtools::install_github("adletaw/captioner")
or if you want the vignette:
devtools::install_github("adletaw/captioner", build_vignettes = TRUE)vignette("using_captioner")
Usage
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)
"Figure 1"
Or you can store the caption and use it in your R code chunk in markdown documents:
> my_first_caption <- fig_nums("my pretty_figure", "my pretty figure's caption")
If you create a new set of captions, perhaps for your tables, the numbering restarts:
> table_nums <- captioner(prefix = "Table")
> table_nums("damn_fine_table", "this table is damn fine")
"Table 1: this table is damn fine"
You can abbreviate in text citations by using partial1 from the package pryr to create a shorter version of the function. For example:
> citef <- partial(fig_nums, cite = TRUE)
Now you can shorten this:
> fig_nums("my_pretty_figure", cite = TRUE)
To this:
> citef("my_pretty_figure")
Take a look at the vignette for many more details.
- I learned this from the glorious H Wickham and you can too