sprinkle_float: Change the float Property in a Dust Table

Description Usage Arguments Details Functional Requirements Author(s) Source See Also

View source: R/sprinkle_float.R

Description

Alter the floating behavior of tables rendered in LaTeX documents. Floating tables are moved to a position deemed ideal by the typesetter. Setting float = FALSE causes the table to be rendered in the position in which it is generated in the code.

Usage

1
2
3
4
5
6
7
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)

## Default S3 method:
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)

## S3 method for class 'dust_list'
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)

Arguments

x

An object of class dust

float

logical(1) indicating if the table should be placed in a floating environment.

...

Additional arguments to pass to other methods. Currently ignored.

Details

See https://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions for more about floating environments in LaTeX.

This property has no effect on non-LaTeX output.

Functional Requirements

  1. Change the float attribute of the dust object.

  2. Cast an error if x is not a dust object.

  3. Cast an error if float is not logical or length 1.

Author(s)

Benjamin Nutter

Source

https://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions

See Also

dust, sprinkle


pixiedust documentation built on Jan. 16, 2021, 5:25 p.m.