clindoc {clinify} | R Documentation |
Create a clindoc
object
Description
These functions handle the conversion of a clintable
object into a clindoc
object.
Usage
clindoc(...)
as_clindoc(x)
Arguments
... |
|
x |
A |
Details
-
as_clindoc()
is intended for a single clintable object and extracts all necessary title and footnote information to apply to the document -
clindoc()
can acceptclintable
objects as separate parameters or as a list ofclintable
objects. If a singleclintable
is passed, this function simply callsas_clindoc()
internally.
When a multiple clintable
objects are passed to clindoc()
, titles and footnotes
should be applied directly to the clindoc
object using clin_add_title()
,
clin_add_footnote()
, or clin_add_footnote_page()
. Title and footnote information
on the individual clintable
objects will be ignored.
Value
a clindoc
object, inherited from an officer::rdocx
object
Examples
ct <- clintable(mtcars)
clindoc(ct)