ftwrite

writeFlextab

Stamp and write flextab objects to one or multiple formats

Write output (plots and tables) ensuring traceability back to code. Includes a graphics saver with simple automation of stamping with source, destination and creation time. A list of plots can be saved at once. A user-friendly selection of output dimensions for presentations, on-screen inspections, and more available.

Philip Delff

tracee

Easily Save Output and Trace it Back to Code

ftwrite function

<dl><dt>ft</dt>
<dd>A flextab object.</dd>
<dt>file</dt>
<dd>to save to. See formats to generate multiple files.</dd>
<dt>script</dt>
<dd>path to script - will be pasted as caption. If
provided, a stamp will be included on the plot when writng
file(s).</dd>
<dt>time</dt>
<dd>The default behavior is to include a time stamp if
<code>script</code> is provided. You can pass any string as <code>time</code> if you
prefer a different format or a completely different string
here instead (like model name?). Use <code>time=""</code> to omit.</dd>
<dt>formats</dt>
<dd>One or more of png, docx, pptx, html. As a
character vector.</dd>
<dt>save</dt>
<dd>Save the table to the given file or just show?
Defaults to TRUE. Hint, if you use an "exportFlag", use
save=exportFlag.</dd>
<dt>quiet</dt>
<dd>Default is false but use TRUE to suppress messages
about what was saved.</dd>
<dt>...</dt>
<dd>Arguments passed to stampFlextab.</dd></dl>

Arguments

<ul>
<li><code>writeFlextab</code>: Deprecated function name. Use ftwrite.</li>
</ul>

Functions

Stamp and write flextab objects to one or multiple formats — ftwrite

<dl>

<dt>ft</dt>
<dd>A flextab object.</dd>


<dt>file</dt>
<dd>to save to. See formats to generate multiple files.</dd>


<dt>script</dt>
<dd>path to script - will be pasted as caption. If
provided, a stamp will be included on the plot when writng
file(s).</dd>


<dt>time</dt>
<dd>The default behavior is to include a time stamp if
<code>script</code> is provided. You can pass any string as <code>time</code> if you
prefer a different format or a completely different string
here instead (like model name?). Use <code>time=""</code> to omit.</dd>


<dt>formats</dt>
<dd>One or more of png, docx, pptx, html. As a
character vector.</dd>


<dt>save</dt>
<dd>Save the table to the given file or just show?
Defaults to TRUE. Hint, if you use an "exportFlag", use
save=exportFlag.</dd>


<dt>quiet</dt>
<dd>Default is false but use TRUE to suppress messages
about what was saved.</dd>


<dt>...</dt>
<dd>Arguments passed to stampFlextab.</dd>

</dl>

ftwrite: Stamp and write flextab objects to one or multiple formats

Description

Usage

Arguments

Functions