tab_stubhead

Add a label to the stubhead of a gt table. The stubhead is the lone
element that is positioned left of the column labels, and above the stub. If
a stub does not exist, then there is no stubhead (so no change will be made
when using this function in that case). We have the flexibility to use
Markdown formatting for the stubhead label. Furthermore, if the table is
intended for HTML output, we can use HTML for the stubhead label.

Build display tables from tabular data with an easy-to-use set of
functions. With its progressive approach, we can construct display tables
with a cohesive set of table parts. Table values can be formatted using any
of the included formatting functions. Footnotes and cell styles can be
precisely added through a location targeting system. The way in which 'gt'
handles things for you means that you don't often have to worry about the
fine details.

Richard Iannone

Easily Create Presentation-Ready Display Tables

Joe Cheng

Barret Schloerke

Ellis Hughes

JooYoung Seo

RStudio 

tab_stubhead function

<dl><dt>data</dt>
<dd>A table object that is created using the <code>gt()</code> function.</dd>
<dt>label</dt>
<dd>The text to be used as the stubhead label We can optionally use
the <code>md()</code> and <code>html()</code> functions to style the text as Markdown or to
retain HTML elements in the text.</dd></dl>

Arguments

Use <code>gtcars</code> to create a gt table. With <code>tab_stubhead()</code> we can add a
stubhead label. This appears in the top-left and can be used to describe what
is in the stub.
<div class="sourceCode r"></div><pre><code>gtcars %&gt;%
 dplyr::select(model, year, hp, trq) %&gt;%
 dplyr::slice(1:5) %&gt;%
 gt(rowname_col = "model") %&gt;%
 tab_stubhead(label = "car")
</code></pre>
<img src="https://raw.githubusercontent.com/rstudio/gt/master/images/man_tab_stubhead_1.png" alt="This image of a table was generated from the first code example in the `tab_stubhead()` help file." style="width:100%;">

Examples

Function ID

Add label text to the stubhead — tab_stubhead

<dl>

<dt>data</dt>
<dd>A table object that is created using the <code>gt()</code> function.</dd>


<dt>label</dt>
<dd>The text to be used as the stubhead label We can optionally use
the <code>md()</code> and <code>html()</code> functions to style the text as Markdown or to
retain HTML elements in the text.</dd>

</dl>

Use <code>gtcars</code> to create a gt table. With <code>tab_stubhead()</code> we can add a
stubhead label. This appears in the top-left and can be used to describe what
is in the stub.
<div class="sourceCode r"><pre><code>gtcars %&gt;%
 dplyr::select(model, year, hp, trq) %&gt;%
 dplyr::slice(1:5) %&gt;%
 gt(rowname_col = "model") %&gt;%
 tab_stubhead(label = "car")
</code></pre></div>
<img src="https://raw.githubusercontent.com/rstudio/gt/master/images/man_tab_stubhead_1.png" alt="This image of a table was generated from the first code example in the `tab_stubhead()` help file." style="width:100%;">

tab_stubhead: Add label text to the stubhead

Description

Usage

Value

Arguments

Examples

Function ID

See Also