label

label&lt;-

An R object to extract labels from.

Logical. When x is a data frame, setting this argument to
<code>TRUE</code> will make the function return all variable labels. By default,
its value is <code>FALSE</code>, so that if x is a data frame, it is the data
frame's label that will be returned.

a logical value indicating if labels should fallback to
object name(s). Defaults to <code>FALSE</code>.

fallback

When x is a data frame and <code>all = TRUE</code>, coerce results
to a vector and remove <code>NA</code>'s. Default is <code>FALSE</code>.

simplify

String to be used as label. To clear existing labels, use <code>NA</code>
or <code>NULL</code>.

value

Assigns a label to a vector or data frame, or returns value stored 
in the object's <code>label</code> attribute (or <code>NA</code> if none exists).

Data frame summaries, cross-tabulations,
weight-enabled frequency tables and common descriptive
(univariate) statistics in concise tables available in a
variety of formats (plain ASCII, Markdown and HTML). A good
point-of-entry for exploring data, both for experienced
and new R users.

Dominic Comtois

summarytools

Tools to Quickly and Neatly Summarize Data

label function

<dl><dt>x</dt>
<dd>An R object to extract labels from.</dd>
<dt>all</dt>
<dd>Logical. When x is a data frame, setting this argument to
<code>TRUE</code> will make the function return all variable labels. By default,
its value is <code>FALSE</code>, so that if x is a data frame, it is the data
frame's label that will be returned.</dd>
<dt>fallback</dt>
<dd>a logical value indicating if labels should fallback to
object name(s). Defaults to <code>FALSE</code>.</dd>
<dt>simplify</dt>
<dd>When x is a data frame and <code>all = TRUE</code>, coerce results
to a vector and remove <code>NA</code>'s. Default is <code>FALSE</code>.</dd>
<dt>value</dt>
<dd>String to be used as label. To clear existing labels, use <code>NA</code>
or <code>NULL</code>.</dd></dl>

Arguments

Dominic Comtois, <a href="/link/dominic.comtois%40gmail.com?package=summarytools&version=1.0.1" data-mini-rdoc="summarytools::dominic.comtois@gmail.com">dominic.comtois@gmail.com</a>,

Author

Get or Set Variable or Data Frame Labels — label

<dl>

<dt>x</dt>
<dd>An R object to extract labels from.</dd>


<dt>all</dt>
<dd>Logical. When x is a data frame, setting this argument to
<code>TRUE</code> will make the function return all variable labels. By default,
its value is <code>FALSE</code>, so that if x is a data frame, it is the data
frame's label that will be returned.</dd>


<dt>fallback</dt>
<dd>a logical value indicating if labels should fallback to
object name(s). Defaults to <code>FALSE</code>.</dd>


<dt>simplify</dt>
<dd>When x is a data frame and <code>all = TRUE</code>, coerce results
to a vector and remove <code>NA</code>'s. Default is <code>FALSE</code>.</dd>


<dt>value</dt>
<dd>String to be used as label. To clear existing labels, use <code>NA</code>
or <code>NULL</code>.</dd>

</dl>

Dominic Comtois, <a href='mailto:dominic.comtois@gmail.com'>dominic.comtois@gmail.com</a>,

label: Get or Set Variable or Data Frame Labels

Description

Usage

Arguments

Author