tidy_htmlTable: Generate an htmlTable using a ggplot2-like interface

In graggsd/tidytableR: Builds Tables from Tidy Datasets

Description

Builds an htmlTable by mapping columns from the input data, x, to elements of an output htmlTable (e.g. rnames, header, etc.)

Usage

tidy_htmlTable(x, value = "value", header = "header", rnames = "rnames",
  rgroup = NULL, cgroup1 = NULL, cgroup2 = NULL, tspanner = NULL,
  hidden_rgroup = NULL, hidden_cgroup1 = NULL, hidden_cgroup2 = NULL,
  hidden_tspanner = NULL, ...)

Arguments

x	A tidy data.frame
value	Column in x specifying values used to populate individual cells of the output table
header	Column in x specifying column headings
rnames	Column in x specifying row names
rgroup	Column in x specifying row groups
cgroup1	Column in x specifying the inner most column groups
cgroup2	Column in x specifying the outer most column groups
tspanner	Column in x specifying tspanner groups
hidden_rgroup	rgroup values that will be hidden.
hidden_cgroup1	cgroup1 values that will be hidden.
hidden_cgroup2	cgroup2 values that will be hidden.
hidden_tspanner	tspanner values that will be hidden.
...	Additional arguments that will be passed to the inner htmlTable function

Value

Returns html code that will build a pretty table

Column-mapping parameters

The tidy_htmlTable function is designed to work like ggplot2 in that columns from x are mapped to specific parameters from the htmlTable function. At minimum, x must contain the names of columns mapping to rnames, header, and rnames. header and rnames retain the same meaning as in the htmlTable function. value contains the individual values that will be used to fill each cell within the output htmlTable.

A full list of parameters from htmlTable which may be mapped to columns within x include:

• value

• header

• rnames

• rgroup

• cgroup1

• cgroup2

• tspanner

Note that unlike in htmlTable which contains cgroup, and which may specify a variable number of column groups, tidy_htmlTable contains the parameters cgroup1 and cgroup2. These parameters correspond to the inward most and outward most column groups respectively.

Also note that the coordinates of each value within x must be unambiguously mapped to a position within the output htmlTable. Therefore, for each row-wise combination of the variables contained in x must be unique.

Hidden values

htmlTable Allows for some values within rgroup, cgroup, etc. to be specified as "". The following parameters allow for specific values to be treated as if they were a string of length zero in the htmlTable function.

• hidden_rgroup

• hidden_cgroup1

• hidden_cgroup2

• hidden_tspanner

See Also

htmlTable

Examples

## Not run: 
library(tidyverse)
mtcars %>%
    rownames_to_column %>%
    select(rowname, cyl, gear, hp, mpg, qsec) %>%
    gather(per_metric, value, hp, mpg, qsec) %>%
    group_by(cyl, gear, per_metric) %>%
    summarise(Mean = round(mean(value), 1),
              SD = round(sd(value), 1),
              Min = round(min(value), 1),
              Max = round(max(value), 1)) %>%
     gather(summary_stat, value, Mean, SD, Min, Max) %>%
     ungroup %>%
     mutate(gear = paste(gear, "Gears"),
            cyl = paste(cyl, "Cylinders")) %>%
     tidy_htmlTable(header = "gear",
                  cgroup1 = "cyl",
                  cell_value = "value",
                  rnames = "summary_stat",
                  rgroup = "per_metric")

## End(Not run)

graggsd/tidytableR documentation built on May 16, 2019, 11:07 a.m.