Learn R Programming

clinify (version 0.3.0)

clindoc: Create a clindoc object

Description

These functions handle the conversion of a clintable object into a clindoc object.

Usage

clindoc(...)

as_clindoc(x)

Value

a clindoc object, inherited from an officer::rdocx object

Arguments

...

clintable objects to be converted. Or separately, a list of clintable objects

x

A clintable object to be converted.

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 accept clintable objects as separate parameters or as a list of clintable objects. If a single clintable is passed, this function simply calls as_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.

Examples

Run this code

ct <- clintable(mtcars)

clindoc(ct)

Run the code above in your browser using DataLab