The snip_stats()
function can be used as an info_snippet()
function
(i.e., provided to fn
) to produce a five- or seven-number statistical
summary. This inline summary works well within a paragraph of text and can
help in describing the distribution of numerical values in a column.
For a given column, three different types of inline statistical summaries can be provided:
a five-number summary (
"5num"
): minimum, Q1, median, Q3, maximuma seven-number summary (
"7num"
): P2, P9, Q1, median, Q3, P91, P98Bowley's seven-figure summary (
"bowley"
): minimum, P10, Q1, median, Q3, P90, maximum
Usage
snip_stats(column, type = c("5num", "7num", "bowley"))
Arguments
- column
The target column
scalar<character>
// requiredThe name of the column that contains the target values.
- type
Type of statistical summary
singl-kw:[5num|7num|bowley]
// default:"5num"
The type of summary. By default, the
"5num"
keyword is used to generate a five-number summary. Two other options provide seven-number summaries:"7num"
and"bowley"
.
Value
A formula needed for info_snippet()
's fn
argument.
Examples
Generate an informant object, add a snippet with info_snippet()
and
snip_stats()
(giving us a method to get some summary stats for column d
).
Define a location for the snippet result in { }
and then incorporate()
the snippet into the info text. Note here that the order of the
info_columns()
and info_snippet()
calls doesn't matter.
informant <-
create_informant(
tbl = ~ small_table,
tbl_name = "small_table",
label = "An example."
) %>%
info_columns(
columns = d,
`Stats` = "Stats (fivenum): {stats_d}."
) %>%
info_snippet(
snippet_name = "stats_d",
fn = snip_stats(column = "d")
) %>%
incorporate()
We can print the informant
object to see the information report.
informant
See also
Other Information Functions:
info_columns()
,
info_columns_from_tbl()
,
info_section()
,
info_snippet()
,
info_tabular()
,
snip_highest()
,
snip_list()
,
snip_lowest()