Skip to content

Commit ec65914

Browse files
committed
address pkgdown issues and docs
1 parent 5a0012d commit ec65914

29 files changed

Lines changed: 231 additions & 106 deletions

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export(gt_color_rows)
2121
export(gt_double_table)
2222
export(gt_duplicate_column)
2323
export(gt_fa_rank_change)
24+
export(gt_fa_rating)
2425
export(gt_highlight_cols)
2526
export(gt_highlight_rows)
2627
export(gt_hulk_col_numeric)

NEWS.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# gtExtras (development version)
1+
# gtExtras 0.6.0
2+
23
- Handle interquartile range of zero in `gt_plt_summary()` - [#104](https://github.com/jthomasmock/gtExtras/issues/104)
34
- Experimentally handle multiple types of plots in `gt_plt_dist()` - [#102](https://github.com/jthomasmock/gtExtras/issues/102)
5+
- Resolve issues with `gt_plt_summary()` - [#148](https://github.com/jthomasmock/gtExtras/issues/148) and [146](https://github.com/jthomasmock/gtExtras/issues/146)
6+
- Address test issues with svglite - [#147](https://github.com/jthomasmock/gtExtras/issues/147)
7+
- Remove deprecated fontawesome functions `gt_fa_repeats()`, and `gt_fa_column()` in favor of `gt` native functions.
8+
- Address CRAN issues
49

510
# gtExtras 0.5.0
611

@@ -18,16 +23,18 @@
1823
- Add a labelling feature to `gt_plt_bar_pct()` - thanks to @andreweatherman and [PR](https://github.com/jthomasmock/gtExtras/pull/100)
1924

2025
# gtExtras 0.4.5
26+
2127
- Refactor many functions to account for upstream changes in `gt` v0.8.0
2228
- Add a `palette_col` argument to `gt_plt_bullet()` to accept a named column of palette colors as present in the data. Fixed #72
2329
- Fix internals of `gt_theme_pff()` to use `table.font.size` inside `tab_options()` rather than `tab_style()`. Fixed #74
2430
- Fix a few instances of `geom_line()` and `geom_v/hline()` that were throwing warnings for `ggplot2` v3.4.0
25-
- Refactor internals of `fmt_pad_num` to align with @mrcaseb implementation https://gist.github.com/mrcaseb/f0f85b48df7957c27c4205cafccbc5a2
31+
- Refactor internals of `fmt_pad_num` to align with @mrcaseb implementation <https://gist.github.com/mrcaseb/f0f85b48df7957c27c4205cafccbc5a2>
2632
- Refactor many functions that use lines with size parameter, to avoid ggplot2 v.3.4.0 deprecation warnings (affects `gt_plt_bar`, `gt_pct_bar`, `gt_plt_dist`, `gt_plt_conf_int`, `gt_plt_percentile_dot`, `gt_plt_point`, `gt_plt_sparkline`, `gt_win_loss`)
2733

2834
# gtExtras 0.4.3
35+
2936
- Modify internals of `gt_fa_column()` to accept factors with levels not present in the data, ignoring unneeded levels. Thank you to @mikedolanfliss for the suggestion.
30-
- Add `gt_merge_stack_color()` to create a merge/stack with background color - per @mrcaseb and issue #71
37+
- Add `gt_merge_stack_color()` to create a merge/stack with background color - per @mrcaseb and issue #71
3138
- Add `gt_alert_icon()` to create a colored circle based on the range of values in the column.
3239
- Fix a CRAN extra check
3340

@@ -63,19 +70,22 @@
6370
- Prep for and submit initial CRAN release :fingers-crossed:
6471

6572
# gtExtras 0.3.9
73+
6674
- Renamed colors arg in `gt_merge_stack()` to be 'palette'
6775
- Renamed colors arg in `gt_plt_bullet()` to be 'palette'
6876
- Renamed pal arg in `gt_plt_sparkline()` to be 'palette'
6977

7078
# gtExtras 0.3.8
79+
7180
- Renamed `colors` argument in `gt_win_loss()` to `palette`
7281
- Added NA handling to all `fontawesome::fa()` functions, ie `gt_fa_rank_change()`, `gt_fa_repeats()`, `gt_fa_column()`
7382
- Add missing data handling to more plotting functions
7483
- Refactor testing to use `webshot2::webshot()` over `webshot::webshot()`
7584
- Remove `gt_sparkline()` - functions separated into `gt_plt_sparkline()` and `gt_plt_dist()`
7685

7786
# gtExtras 0.3.7
78-
- Added basic support in `gt_plt_summary()` for dates/times.
87+
88+
- Added basic support in `gt_plt_summary()` for dates/times.
7989
- Updated tests for `gt_plt_summary()` to include dates/times
8090

8191
# gtExtras 0.3.6
@@ -95,34 +105,34 @@
95105

96106
# gtExtras 0.3.2
97107

98-
* Remove `scales::scales_label_si()` in favor of `scales::label_number(scale_cut = cut_scale_short())` as the previous function was deprecated. Thanks to [@mrcaseb](https://github.com/mrcaseb) for pointing out in [Issue 48](https://github.com/jthomasmock/gtExtras/issues/48)
108+
- Remove `scales::scales_label_si()` in favor of `scales::label_number(scale_cut = cut_scale_short())` as the previous function was deprecated. Thanks to [@mrcaseb](https://github.com/mrcaseb) for pointing out in [Issue 48](https://github.com/jthomasmock/gtExtras/issues/48)
99109

100110
# gtExtras 0.3
101111

102-
* Add [Daniel Sjoberg](https://github.com/ddsjoberg) as a contributor in honor of their major assistance with preparation towards CRAN
103-
* Move past 0.2 release into a "next stop CRAN"... hopefully
104-
* Vendor additional unexported functions from `{gt}` with attribution
112+
- Add [Daniel Sjoberg](https://github.com/ddsjoberg) as a contributor in honor of their major assistance with preparation towards CRAN
113+
- Move past 0.2 release into a "next stop CRAN"... hopefully
114+
- Vendor additional unexported functions from `{gt}` with attribution
105115

106116
# gtExtras 0.2.7
107117

108-
* Bring in `webshot2` as a remote dependency suggest and minor changes to clean up some R checks, thanks to a PR from the great [Daniel Sjoberg](https://github.com/jthomasmock/gtExtras/pull/43).
118+
- Bring in `webshot2` as a remote dependency suggest and minor changes to clean up some R checks, thanks to a PR from the great [Daniel Sjoberg](https://github.com/jthomasmock/gtExtras/pull/43).
109119

110-
* Correct an internal bug in `gt_plt_dist()` which was failing for plotting integers.
120+
- Correct an internal bug in `gt_plt_dist()` which was failing for plotting integers.
111121

112122
# gtExtras 0.2.6
113123

114-
* Exchange `webshot` for `webshot2` to enhance capabilities. Note that `webshot2` is GitHub only, install via: `remotes::install_github("rstudio/webshot2")`. This solves [issue #42](https://github.com/jthomasmock/gtExtras/issues/42).
124+
- Exchange `webshot` for `webshot2` to enhance capabilities. Note that `webshot2` is GitHub only, install via: `remotes::install_github("rstudio/webshot2")`. This solves [issue #42](https://github.com/jthomasmock/gtExtras/issues/42).
115125

116126
# gtExtras 0.2.5
117127

118-
* Updated `gt_theme_guardian()` to work with zero-length tables per [Issue 41](https://github.com/jthomasmock/gtExtras/issues/41)
128+
- Updated `gt_theme_guardian()` to work with zero-length tables per [Issue 41](https://github.com/jthomasmock/gtExtras/issues/41)
119129

120130
# gtExtras 0.2.4
121131

122-
* Added a `NEWS.md` file to track changes to the package.
132+
- Added a `NEWS.md` file to track changes to the package.
123133

124134
## Bug Fixes prior to 0.2.4
125135

126-
* Use `gt_index` to prevent incorrect ordering of rows with `gt_plt_bar_pct()` per [StackOverflow report](https://stackoverflow.com/questions/71313688/gtextras-column-showing-in-wrong-order-in-gt-table-when-grouped?noredirect=1#comment126232993_71313688)
136+
- Use `gt_index` to prevent incorrect ordering of rows with `gt_plt_bar_pct()` per [StackOverflow report](https://stackoverflow.com/questions/71313688/gtextras-column-showing-in-wrong-order-in-gt-table-when-grouped?noredirect=1#comment126232993_71313688)
127137

128-
* Remove `keep_column` argument for `gt_plt_bullet`, this functionality is able to be achieved with `gt_duplicate_column()` upstream. This also solves naming confusion as seen in [issue 37](https://github.com/jthomasmock/gtExtras/issues/37)
138+
- Remove `keep_column` argument for `gt_plt_bullet`, this functionality is able to be achieved with `gt_duplicate_column()` upstream. This also solves naming confusion as seen in [issue 37](https://github.com/jthomasmock/gtExtras/issues/37)

_pkgdown.yml

Lines changed: 93 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -9,97 +9,99 @@ template:
99
src: man/figures/opengraph.png
1010
alt: The package hex logo, it is pixel art of a table with a computer on top. A small boston terrier is underneath and then the text gtExtras.
1111
twitter:
12-
creator: '@thomas_mock'
12+
creator: "@thomas_mock"
1313
site: https://jthomasmock.github.io/gtExtras
1414
card: summary
1515
reference:
16-
- title: Themes
17-
desc: Full blown `{gt}` themes that affect most if not all visual components of
18-
the table. Similar in spirit to `{ggplot2}` themes like `ggplot2::theme_minimal()`
19-
or `{ggthemes}` like `ggthemes::theme_fivethirtyeight()`.
20-
contents:
21-
- gt_theme_538
22-
- gt_theme_espn
23-
- gt_theme_nytimes
24-
- gt_theme_guardian
25-
- gt_theme_dot_matrix
26-
- gt_theme_dark
27-
- gt_theme_excel
28-
- gt_theme_pff
29-
- title: Plotting
30-
desc: Add plots to specific rows of an existing table
31-
contents:
32-
- gt_plt_bar
33-
- gt_plt_bar_pct
34-
- gt_plt_bar_stack
35-
- gt_plt_bullet
36-
- gt_plt_conf_int
37-
- gt_plt_dist
38-
- gt_plt_dot
39-
- gt_plt_dumbbell
40-
- gt_plt_percentile
41-
- gt_plt_point
42-
- gt_plt_sparkline
43-
- gt_plt_summary
44-
- gt_plt_winloss
45-
- title: Images and icons
46-
desc: Add fontawesome icons or web images to a table
47-
contents:
48-
- fa_icon_repeat
49-
- gt_fa_column
50-
- gt_fa_repeats
51-
- gt_fa_rating
52-
- gt_fa_rank_change
53-
- add_text_img
54-
- img_header
55-
- gt_img_rows
56-
- gt_img_multi_rows
57-
- gt_img_circle
58-
- gt_img_border
59-
- title: Colors
60-
desc: Add color to the entire table or to specific locations. Includes wrappers
61-
around the `{scales}` and `{paletteer}` packages that provide easier or more succinct
62-
applications of palettes and colors inside `{gt}`.
63-
contents:
64-
- gt_hulk_col_numeric
65-
- gt_color_rows
66-
- gt_color_box
67-
- gt_alert_icon
68-
- title: HTML Helpers
69-
desc: Various HTML helpers to avoid repeated boilerplate
70-
contents:
71-
- gt_label_details
72-
- with_tooltip
73-
- gt_hyperlink
74-
- title: Utilities
75-
desc: Helper functions and utilities with features not _yet_ built into `{gt}`.
76-
contents:
77-
- fmt_symbol_first
78-
- fmt_pad_num
79-
- fmt_pct_extra
80-
- pad_fn
81-
- gt_merge_stack
82-
- gt_merge_stack_color
83-
- gt_highlight_rows
84-
- gt_highlight_cols
85-
- gt_add_divider
86-
- tab_style_by_grp
87-
- gt_double_table
88-
- gt_two_column_layout
89-
- gtsave_extra
90-
- gt_duplicate_column
91-
- gt_index
92-
- get_row_index
93-
- generate_df
94-
- gt_reprex_image
95-
- title: internal
96-
desc: Internally used functions
97-
contents:
98-
- add_badge_color
99-
- add_pcttile_plot
100-
- add_point_plot
101-
- gt_badge
102-
- n_decimals
103-
- create_sum_table
104-
- plot_data
105-
- last_row_id
16+
- title: Themes
17+
desc:
18+
Full blown `{gt}` themes that affect most if not all visual components of
19+
the table. Similar in spirit to `{ggplot2}` themes like `ggplot2::theme_minimal()`
20+
or `{ggthemes}` like `ggthemes::theme_fivethirtyeight()`.
21+
contents:
22+
- gt_theme_538
23+
- gt_theme_espn
24+
- gt_theme_nytimes
25+
- gt_theme_guardian
26+
- gt_theme_dot_matrix
27+
- gt_theme_dark
28+
- gt_theme_excel
29+
- gt_theme_pff
30+
- title: Plotting
31+
desc: Add plots to specific rows of an existing table
32+
contents:
33+
- gt_plt_bar
34+
- gt_plt_bar_pct
35+
- gt_plt_bar_stack
36+
- gt_plt_bullet
37+
- gt_plt_conf_int
38+
- gt_plt_dist
39+
- gt_plt_dot
40+
- gt_plt_dumbbell
41+
- gt_plt_percentile
42+
- gt_plt_point
43+
- gt_plt_sparkline
44+
- gt_plt_summary
45+
- gt_plt_winloss
46+
- title: Images and icons
47+
desc: Add fontawesome icons or web images to a table
48+
contents:
49+
- fa_icon_repeat
50+
# - gt_fa_column
51+
# - gt_fa_repeats
52+
- gt_fa_rating
53+
- gt_fa_rank_change
54+
- add_text_img
55+
- img_header
56+
- gt_img_rows
57+
- gt_img_multi_rows
58+
- gt_img_circle
59+
- gt_img_border
60+
- title: Colors
61+
desc:
62+
Add color to the entire table or to specific locations. Includes wrappers
63+
around the `{scales}` and `{paletteer}` packages that provide easier or more succinct
64+
applications of palettes and colors inside `{gt}`.
65+
contents:
66+
- gt_hulk_col_numeric
67+
- gt_color_rows
68+
- gt_color_box
69+
- gt_alert_icon
70+
- title: HTML Helpers
71+
desc: Various HTML helpers to avoid repeated boilerplate
72+
contents:
73+
- gt_label_details
74+
- with_tooltip
75+
- gt_hyperlink
76+
- title: Utilities
77+
desc: Helper functions and utilities with features not _yet_ built into `{gt}`.
78+
contents:
79+
- fmt_symbol_first
80+
- fmt_pad_num
81+
- fmt_pct_extra
82+
- pad_fn
83+
- gt_merge_stack
84+
- gt_merge_stack_color
85+
- gt_highlight_rows
86+
- gt_highlight_cols
87+
- gt_add_divider
88+
- tab_style_by_grp
89+
- gt_double_table
90+
- gt_two_column_layout
91+
- gtsave_extra
92+
- gt_duplicate_column
93+
- gt_index
94+
- get_row_index
95+
- generate_df
96+
- gt_reprex_image
97+
- title: internal
98+
desc: Internally used functions
99+
contents:
100+
- add_badge_color
101+
- add_pcttile_plot
102+
- add_point_plot
103+
- gt_badge
104+
- n_decimals
105+
- create_sum_table
106+
- plot_data
107+
- last_row_id

man/add_text_img.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/fa_icon_repeat.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/fmt_pad_num.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/fmt_pct_extra.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/fmt_symbol_first.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/generate_df.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/gt_add_divider.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)