A wrapper for pretty_captioner with sensible defaults for captioning figures

A wrapper for pretty_captioner with sensible defaults for captioning figures

pretty_figref(label = NULL, caption = NULL, prefix = "Figure",
  sec_prefix = NULL, auto_space = TRUE, levels = 1, type = NULL,
  infix = ".", display = "full", inline = FALSE, reinit = FALSE, ...)

Arguments

label	Character string containing a unique object name.
caption	Character string containing the object caption.
prefix	Character string containing text to go before object number. The default is Figure.
sec_prefix	Character string containing text to between prefix and object number. The default is to add nothing.
auto_space	Logical indicating whether or not a space should automatically be added following the prefix. Space is added by default.
levels	Logical or number indicating whether or not you want hierarchical numbering, and if so, how many levels. Hierarchical numbering is turned off by default.
type	Vector with same length as levels indicating whether figure numbering should be numeric (n), lowercase character (c), or uppercase character (C). If unspecified, captioner will revert to all numeric values.
infix	Character string containing text to go between figure numbers if hierarchical numbering is on. Default is .
display	Character string (logical) indicating what display mode you would like: full (or f) displays all information, cite (or c) displays just the prefix and number, and num (or n) displays just the number.
inline	Logical indicating whether the function should display the prefix uncapitalised/capitalised.
reinit	Logical indicating whether to reinitialise the underlying captioner function.
...	Pass additional arguements to the intialised captioner function

Value

A character string containing the table/figure number, and optionally the caption.

Details

As a wrapper for the captioner function pretty_captioner intialises a captioner function in the global enviroment. This is then used by pretty_captioner to return a character string containing the prefix, sec_prefix, and object number with or without a caption. The initial numbering is determined based on the order of caption creation. However, this order is modified based on the citations you use. The first object to be cited will be moved to the beginning of the list, becoming object 1. Changing captioner parameters (prefix, sec_prefix, auto_space, levels, type, and infix) requires the captioner function to be reinitialised by setting reinit to TRUE. The captioner function can also be initialised without reference to an object by not supplying a label or caption argument. For more details see captioner.

See also

pretty_captioner pretty_suptabref pretty_figref pretty_supfigref

Examples

## Generate a simple reference
pretty_figref('1' , 'Example', reinit = TRUE)
#> Initialising captioning function: figref
#> [1] "Figure 1: Example"

## cite in text
pretty_figref('1')
#> [1] "Figure 1"

## Drop captilisation for use in line
pretty_figref('1', inline = TRUE)
#> [1] "figure 1"

## Add another table caption
pretty_figref('2' , 'Example 2')
#> [1] "Figure 2: Example 2"