This function creates a table in OMNI's style.
Usage
omni_table(
df,
group_by = NULL,
first_col_gray = FALSE,
caption = NULL,
with_stripes = TRUE
)Arguments
- df
The data frame to be put into the table
- group_by
Character vector containing of grouping variables
- first_col_gray
Should the first column be gray. Default to FALSE
- caption
The caption of the table
- with_stripes
TRUE or FALSE depending on whether a striped pattern should be used. Defaults to TRUE (which uses stripes.)
Examples
palmerpenguins::penguins |>
dplyr::slice(1:3) |>
omni_table()
species
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2,007
Adelie
Torgersen
39.5
17.4
186
3,800
female
2,007
Adelie
Torgersen
40.3
18.0
195
3,250
female
2,007
palmerpenguins::penguins |>
dplyr::slice(1:3) |>
omni_table(first_col_gray = TRUE)
species
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2,007
Adelie
Torgersen
39.5
17.4
186
3,800
female
2,007
Adelie
Torgersen
40.3
18.0
195
3,250
female
2,007
palmerpenguins::penguins |>
dplyr::slice(1:3, .by = species) |>
omni_table(group_by = 'species')
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2,007
Torgersen
39.5
17.4
186
3,800
female
2,007
Torgersen
40.3
18.0
195
3,250
female
2,007
Gentoo
Biscoe
46.1
13.2
211
4,500
female
2,007
Biscoe
50.0
16.3
230
5,700
male
2,007
Biscoe
48.7
14.1
210
4,450
female
2,007
Chinstrap
Dream
46.5
17.9
192
3,500
female
2,007
Dream
50.0
19.5
196
3,900
male
2,007
Dream
51.3
19.2
193
3,650
male
2,007
palmerpenguins::penguins |>
dplyr::slice(1:3) |>
omni_table(caption = 'Table 1. [Insert Table Name]')
Table 1. [Insert Table Name] species
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2,007
Adelie
Torgersen
39.5
17.4
186
3,800
female
2,007
Adelie
Torgersen
40.3
18.0
195
3,250
female
2,007
# Without striped pattern
palmerpenguins::penguins |>
dplyr::slice(1:3) |>
omni_table(with_stripes = FALSE)
species
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2,007
Adelie
Torgersen
39.5
17.4
186
3,800
female
2,007
Adelie
Torgersen
40.3
18.0
195
3,250
female
2,007
# Overwrite number formatting by transforming to character format
palmerpenguins::penguins |>
dplyr::slice(1:3) |>
dplyr::mutate(year = as.character(year)) |>
omni_table()
species
island
bill_length_mm
bill_depth_mm
flipper_length_mm
body_mass_g
sex
year
Adelie
Torgersen
39.1
18.7
181
3,750
male
2007
Adelie
Torgersen
39.5
17.4
186
3,800
female
2007
Adelie
Torgersen
40.3
18.0
195
3,250
female
2007