A drop in replacement for tidyr::pivot_wider()
which optionally takes a
message and headline to store in the history graph.
Usage
# S3 method for class 'trackr_df'
pivot_wider(data, ..., .messages = "", .headline = "", .tag = NULL)
Arguments
- data
A data frame to pivot.
- ...
Additional arguments passed on to methods. Named arguments passed on to
tidyr::pivot_wider
id_cols
<
tidy-select
> A set of columns that uniquely identify each observation. Typically used when you have redundant variables, i.e. variables whose values are perfectly correlated with existing variables.Defaults to all columns in
data
except for the columns specified throughnames_from
andvalues_from
. If a tidyselect expression is supplied, it will be evaluated ondata
after removing the columns specified throughnames_from
andvalues_from
.id_expand
Should the values in the
id_cols
columns be expanded byexpand()
before pivoting? This results in more rows, the output will contain a complete expansion of all possible values inid_cols
. Implicit factor levels that aren't represented in the data will become explicit. Additionally, the row values corresponding to the expandedid_cols
will be sorted.names_from,values_from
<
tidy-select
> A pair of arguments describing which column (or columns) to get the name of the output column (names_from
), and which column (or columns) to get the cell values from (values_from
).If
values_from
contains multiple values, the value will be added to the front of the output column.names_prefix
String added to the start of every variable name. This is particularly useful if
names_from
is a numeric vector and you want to create syntactic variable names.names_sep
If
names_from
orvalues_from
contains multiple variables, this will be used to join their values together into a single string to use as a column name.names_glue
Instead of
names_sep
andnames_prefix
, you can supply a glue specification that uses thenames_from
columns (and special.value
) to create custom column names.names_sort
Should the column names be sorted? If
FALSE
, the default, column names are ordered by first appearance.names_vary
When
names_from
identifies a column (or columns) with multiple unique values, and multiplevalues_from
columns are provided, in what order should the resulting column names be combined?"fastest"
variesnames_from
values fastest, resulting in a column naming scheme of the form:value1_name1, value1_name2, value2_name1, value2_name2
. This is the default."slowest"
variesnames_from
values slowest, resulting in a column naming scheme of the form:value1_name1, value2_name1, value1_name2, value2_name2
.
names_expand
Should the values in the
names_from
columns be expanded byexpand()
before pivoting? This results in more columns, the output will contain column names corresponding to a complete expansion of all possible values innames_from
. Implicit factor levels that aren't represented in the data will become explicit. Additionally, the column names will be sorted, identical to whatnames_sort
would produce.names_repair
What happens if the output has invalid column names? The default,
"check_unique"
is to error if the columns are duplicated. Use"minimal"
to allow duplicates in the output, or"unique"
to de-duplicated by adding numeric suffixes. Seevctrs::vec_as_names()
for more options.values_fill
Optionally, a (scalar) value that specifies what each
value
should be filled in with when missing.This can be a named list if you want to apply different fill values to different value columns.
values_fn
Optionally, a function applied to the value in each cell in the output. You will typically use this when the combination of
id_cols
andnames_from
columns does not uniquely identify an observation.This can be a named list if you want to apply different aggregations to different
values_from
columns.unused_fn
Optionally, a function applied to summarize the values from the unused columns (i.e. columns not identified by
id_cols
,names_from
, orvalues_from
).The default drops all unused columns from the result.
This can be a named list if you want to apply different aggregations to different unused columns.
id_cols
must be supplied forunused_fn
to be useful, since otherwise all unspecified columns will be consideredid_cols
.This is similar to grouping by the
id_cols
then summarizing the unused columns usingunused_fn
.
- .messages
a set of glue specs. The glue code can use any global variable, grouping variable, or {.strata}. Defaults to nothing.
- .headline
a headline glue spec. The glue code can use any global variable, grouping variable, or {.strata}. Defaults to nothing.
- .tag
if you want the summary data from this step in the future then give it a name with .tag.
Value
the data dataframe result of the tidyr::pivot_wider
function but with
a history graph updated with a .message
if requested.