pixie_count: Access and manipulate table numbers counters
In pixiedust: Tables so Beautifully Fine-Tuned You Will Believe It's Magic

pixie_count

R Documentation

Access and manipulate table numbers counters

Description

While LaTeX provides the ability to automatically number tables, this functionality is not readily available with console, HTML, or Word output. By keep track of the number of (captioned) tables, we can mimic the behavior of LaTeX tables to provide (mostly) consistent table numbering between formats. The table numbering is stored in the pixie_count option.

Usage

get_pixie_count()

set_pixie_count(value)

increment_pixie_count(increment = 1)

Arguments

`value`	The value at which to set the pixie counter.
`increment`	The value to add to the current pixie count. Defaults to 1.

Details

The pixie count is stored in the options and may also be accessed using getOption("pixie_count").

get_pixie_count returns the current value of the counter.

set_pixie_count sets the value to the user-specification.

increment_pixie_count increments the pixie count, usually by 1. This is called within print.dust any time a dust object has a caption.

Author(s)

Benjamin Nutter

Source

The concept for these functions is loosely based on a hook meant to work with knitr to automatically number tables. http://stackoverflow.com/a/18672268/1017276

pixiedust documentation built on Oct. 10, 2023, 9:07 a.m.