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.
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)# S3 method for default
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)
# S3 method for dust_list
sprinkle_float(x, float = getOption("pixie_float", FALSE), ...)
An object of class dust
logical(1) indicating if the table should be placed in
a floating environment.
Additional arguments to pass to other methods. Currently ignored.
Change the float attribute of the dust object.
Cast an error if x is not a dust object.
Cast an error if float is not logical or length 1.
Benjamin Nutter
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.
dust, sprinkle