inTextSummaryTable-DT-args

Common arguments for the functionalities of the inTextSummaryTable package
for DT export.

Creation of tables of summary statistics or counts for clinical data (for 'TLFs').
These tables can be exported as in-text table (with the 'flextable' package) for a Clinical Study Report
(Word format) or a 'topline' presentation (PowerPoint format),
or as interactive table (with the 'DT' package) to an html document for clinical data review.

Laure Cougnaud

inTextSummaryTable

Creation of in-Text Summary Table

Michela Pasetto

Margaux Faes

Open Analytics 

inTextSummaryTable-DT-args function

<dl><dt>expandVar</dt>
<dd>(DT output) Character vector with variables of the summary table which
should be expanded in the data.</dd>
<dt>pageDim</dt>
<dd>(DT output) Numeric vector of length 2 with page width and height,
in number of rows (currently only
the height is used (e.g. <code>c(NA, 4)</code>)</dd>
<dt>noEscapeVar</dt>
<dd>(DT output) Character vector with variables of <code>summaryTable</code>
which shouldn't be escaped in the table (e.g. containing URLs).</dd>
<dt>barVar</dt>
<dd>(DT output) Character vector with variables of <code>summaryTable</code>
that should be represented as a bar.</dd>
<dt>file</dt>
<dd>String with path of the file where the table should be exported.
The file should have the extension: '.docx'.
If NULL, the summary table is not exported but only returned as output.
If <code>byVar</code> is specified, each table is exported to a separated
file with the suffix: 'file_[i].docx' with i the index of the file.</dd></dl>

Arguments

Common arguments for the functionalities of the inTextSummaryTable package
for DT export. — inTextSummaryTable-DT-args

<dl>

<dt>expandVar</dt>
<dd>(DT output) Character vector with variables of the summary table which
should be expanded in the data.</dd>


<dt>pageDim</dt>
<dd>(DT output) Numeric vector of length 2 with page width and height,
in number of rows (currently only
the height is used (e.g. <code>c(NA, 4)</code>)</dd>


<dt>noEscapeVar</dt>
<dd>(DT output) Character vector with variables of <code>summaryTable</code>
which shouldn't be escaped in the table (e.g. containing URLs).</dd>


<dt>barVar</dt>
<dd>(DT output) Character vector with variables of <code>summaryTable</code>
that should be represented as a bar.</dd>


<dt>file</dt>
<dd>String with path of the file where the table should be exported.
The file should have the extension: '.docx'.
If NULL, the summary table is not exported but only returned as output.
If <code>byVar</code> is specified, each table is exported to a separated
file with the suffix: 'file_[i].docx' with i the index of the file.</dd>

</dl>

inTextSummaryTable-DT-args: Common arguments for the functionalities of the inTextSummaryTable package for DT export.

Description

Value

Arguments