bump: Captioner bump function

Description Usage Arguments Details Value See Also Examples

View source: R/bump.R

Description

For figure numbers with sub-values (e.g. 1.1), increment one of the sub-values for use in the next figure.

Usage

1
bump(cap_fun, level)

Arguments

cap_fun

The captioner function that needs to be bumped

level

Numeric indicating which sub-number should be incremented

Details

Normally captioner only increments the final number in your figure number, even if you have hierarchical numbering (e.g. Fig 1.1.1). This function will bump up any of the penultimate numbers of your choice using a given index. You can use it at the start of a section, for example, to shift from Fig 1.5 to Fig 2.1.

Value

None.

See Also

captioner

Examples

1
2
3
4
figs <- captioner(levels = 2)
figs("a")

bump(figs, 1)

adletaw/captioner documentation built on Feb. 21, 2020, 10:14 p.m.