Merge pull request #1761 from rstudio/v0.11.0-rc

Release gt v0.11.0

Author: rich-iannone

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: gt
 Title: Easily Create Presentation-Ready Display Tables
-Version: 0.10.1.9000
+Version: 0.11.0
 Authors@R: c(
     person("Richard", "Iannone", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-3925-190X")),

NEWS.md

@@ -1,30 +1,120 @@
-# gt (development version)
+# gt 0.11.0
 
-* `summary_rows()` now throws a more informative error message that you should use `grand_summary_rows()` if no row groups are detected (@olivroy, #1292).
- This change was introduced in [gt 0.9.0](https://posit.co/blog/big-changes-to-making-summary-rows-in-gt-0-9-0/)
-* gt now depends on R 3.6 (@olivroy, #1731).
+## New features
+
+* **gt** tables can now be rendered in the grid graphics system with the new `as_gtable()` function (#180, #420, #509, #961, #1652, #1701). Thank you @teunbrand for this valuable contribution! (#1563, #1648, #1655, #1727)
+
+* With the new `fmt_chem()` function, it's possible to format chemical formulas and chemical equations in the table body. (#1636)
+
+* We added `fmt_email()` we can transform email addresses in table cells into usable 'mailto:' links. This operates similarly to `fmt_url()` but removes some unneeded anchor tag attributes (#1616). (#1649)
+
+* The new `fmt_tf()` function lets you format logical values in a **gt** table. You could express these as a 'yes' or 'no', a 'true' or 'false', or, perhaps use pairings of complementary symbols that make sense in a table (#1650). (#1654)
+
+* The new `fmt_country()` was added to help with making country names consistent and localizable. The input text can either consist of 2- or 3-letter ISO 3166-1 country codes. (#1645, #1696)
+
+* Math formulas (written in LaTeX) can now be rendered to HTML through `md()` and `fmt_markdown()`. The LaTeX formulas can be set between `$` or `$$` delimiters for inline and block rendering styles. While this requires the **katex** package to work (it's an optional dependency), the rendering of formulas is dependency-free in the output (#375, #616, #1163). (#1578)
+
+* We added the `unit_conversion()` helper function to help you perform unit conversions. This function returns a conversion factor for transforming a value from one form of measurement units to a target form. This works wonderfully in the `scale_by` argument that is present in many number-based `fmt_*()` functions. (#1704, #1709, #1710, #1729)
+
+* The `plot()` method was added for `gt_tbl` so that one can quickly create a reprex visual example (e.g., `exibble |> gt() |> plot()`). (#1742)
+
+* `info_time_style()` and `info_date_style()` gain a `locale` argument to preview time and date formatting in a specific locale. (#1747)
+
+* `data_color()` throws a more informative error message if `rows` didn't resolve to anything (#1659). (@olivroy, #1660).
+
+* Several datasets were added to the package: `reactions`, `photolysis`, `peeps`, `nuclides`, `gibraltar`, and `films`. (#1619, #1641, #1664, #1668, #1686, #1695)
+
+## Improvements to the LaTeX output format
 
-* `info_time_style()` and `info_date_style()` gain a `locale` argument to preview datetime formatting in a given locale.
+* A host of improvements were made to LaTeX output such that styling made through `tab_options()` and `tab_style()` is now honored. The styling implemented now includes: (1) font size, underlining, italicizing, bolding, indenting text, coloring text, filling cell backgrounds, and modifying text case (i.e., uppercase, lowercase, sentence case) (#1472). (#1594, #1603, #1746, thanks so much @kbrevoort)
 
-* `opt_interactive()` gains `height` to help specify your widget's height (@olivroy, #1544).
+* Text in spanner labels is now nicely wrapped in LaTeX output, where before there would be no wrapping at all (#1656). (#1716, #1746)
 
-* `opt_interactive()` now shows row names if `rownames_to_stub = TRUE` (@olivroy, #1702). 
+* The `gt()` setting of `row_group_as_column == TRUE` is now implemented in LaTeX output. (#1716)
 
-* `data_color()` throws a more informative error message if `rows` didn't resolve to anything (@olivroy, #1659).
+* LaTeX output now understands and can convert from lengths expressed in pixels (an internal conversion to pt units is performed) (#1582). (#1595)
+
+* A fix was made to correct an error related to converting px units to pt units for LaTeX output. (#1591, thank you @AaronGullickson)
+
+## Improvements to interactive HTML tables via `opt_interactive()`
+
+* The performance of interactive table rendering through `opt_interactive()` has  been improved (#1289). (#1735)
+
+* `opt_interactive()` now shows row names if `rownames_to_stub = TRUE` (#1702). (@olivroy, #1706)
+
+* There's now better support for displaying group columns, if present, in interactive tables (#1705). (@olivroy, #1725, #1758, #1760)
+
+* Interactive tables can now display the stub header label created with `tab_stubhead()`. (@olivroy, #1758).
+
+* There is no longer an error when having a hidden column under a spanner label in an interactive HTML table (i.e., `opt_interactive()`) context. (#1629)
+
+* Interactive tables now render the first level of column groups added by `tab_spanner()` (#1618). Thanks @obsaditelnost for your work on this! (#1623)
+
+* The `opt_interactive()` function now has the `height` argument to help specify the height of an interactive table (#1544). (@olivroy, #1723).
+
+* When using `opt_interactive(use_pagination = FALSE)` the pagination controls are now entirely removed instead of merely being non-functional (#1542). (#1642)
+
+* When supplying a locale value to an interactive table, we now ensure that the supplied locale is normalized (so `"fr_CH"` will be internally corrected to `"fr-CH"`) (#1637). (#1643)
+
+## Minor improvements and bug fixes
 
-* PDF output now allows the font size of a table to be set using the table.font.size parameter in the tab_options function (#1472).  The font sizes of individual table cells (including those in the body, stubs, column headings, etc.) can be set using tab_style function. Several other options specified in tab_style are now reflected in PDF output.
+* The `fill_color` argument in `fmt_icon()` now allows the use of named vector/list to apply different colors to different icons (#1560). (#1647)
 
-* `data_color()` throws a more informative error if a calculation failed (@olivroy, #1373).
+* `fmt_flag()` gains a `locale` argument so that SVG title text displays country names in any locale language. (#1645)
 
-* `gtsave()` saves correctly to .rtf if using `cols_label()` and `summary_rows()` or `grand_summary_rows()` (@olivroy, #1233)
+* To better represent missing values in nanoplots, the `"marker"` option has been added in `cols_nanoplot()` (#1567). (#1587)
 
-* interactive tables are now rendering the first level of column groups, added by `tab_spanner()` (@obsaditelnost, #1618)
+* Many of the `info_*()` functions were upgraded with better functionality and a refreshed look. (#1720, #1748, #1754)
 
-* `cols_hide()` no longer errors if no column was supplied. Error messages are also clearer when supplying a column that doesn't exist (@olivroy, #1631).
+* The `metro` dataset has been updated with six new Line 11 stations that opened on 2024-06-13. (#1708)
 
-* `cols_units()`, `tab_footnote()` and `tab_style()` now give better error messages when `locations` is not correctly specified (@olivroy, #475, #1638 , #1640, #1733).
+* For HTML tables produced in Quarto, we now use the `data-qmd-base64` attribute along with base64 text when passing Markdown text to Quarto (which handles the Markdown conversion) (#1487, #1488). (#1688, #1690, #1734)
 
-* `opt_interactive()` has better support for displaying group columns if present (`row_groups_as_column` has no effect on the output) (@olivroy, #1705).
+* Scientific and engineering notation will no longer unexpectedly wrap lines in HTML for smaller column widths. (#1621)
+
+* Footnote marks in HTML table outputs no longer unexpectedly increase the text line height (#1556). (#1644)
+
+* We now ensure tables print correctly when called from inline code in `.qmd` or `.Rmd` documents (#1055). (#1689)
+
+* `data_color()` throws a more informative error if an internal calculation failed (e.g., presence of infinite values) (#1373). (@olivroy, #1585)
+
+* `data_color()` provides an informative error message if `rows` doesn't resolve to anything. (@olivroy, #1659)
+
+* `summary_rows()` now throws a more informative error message that you should use `grand_summary_rows()` if no row groups are detected (#1292). (@olivroy, #1752)
+
+* Boxplot-based nanoplots now correctly determine which data points are outliers. (#1756)
+
+* The issue where having a row group set as a column in the stub, corrupting the setting of column widths in HTML output tables, has been fixed (#1253, #1510). (#1744)
+
+* The rendering of footnotes and source notes received fixes to ensure that all requested notes are inserted and also that the typesetting options in `tab_options()` is implemented (#1505, #1615). (#1620, #1751)
+
+* Using a `fmt_*()` function while the stub is composed of Markdown or HTML no longer results in an error (#1600). (#1627)
+
+* The combination of using `cols_label()` + `summary_rows()` / `grand_summary_rows()` no longer causes an error for RTF output through `gtsave()` (#1233). (#1596)
+
+* We now ensure that `id` values are stripped of HTML tags when using `tab_row_group()`. Previously this condition would create corrupted row group labels (#1143). (#1750)
+
+* `cols_hide()` no longer errors if a column wasn't supplied. Error messages are also clearer when supplying a column that doesn't exist (#1631). (#1632)
+
+* `cols_units()`, `tab_footnote()` and `tab_style()` now give better error messages when `locations` is not correctly specified (#475). (@olivroy, #1638, #1640, #1733)
+
+* Error messages are now improved for `rm_spanners()`, `rm_footnotes()`, and `rm_source_notes()` (#1638). (#1661)
+
+* Error messages for the `vec_*()` functions are now standardized with `check_vector_valid()`. (#1662)
+
+* Running **testthat** tests no longer fails on Windows due to `gtsave()` path incompatibilities (#1626). (#1627)
+
+* Tests run on Windows are less noisy now (no more render related warnings). (#1634)
+
+* Much code refactoring, linting, and test improvements were performed by @olivroy, resulting in many performance gains. (#1666, #1683, #1694, #1699, #1715, #1718, #1728, #1730, #1731, #1732, #1733, #1753)
+
+* **gt** now depends on R 3.6. (#1599, #1731).
+
+## Documentation enhancements
+
+* Many small documentation fixes were performed. (#1555, #1598, #1633, #1658, #1663, #1676, #1685, #1700, #1703, #1717, #1719, #1721)
+
+* More examples were added to further demonstrate how various functions can be used. (#1646, #1667, #1677, #1698, #1724, #1737)
 
 # gt 0.10.1
 
@@ -44,12 +134,14 @@
 
 * Introduced a small performance improvement by no longer calling `utils::packageVersion()` internally (#1524). (#1525, thank you @slodge)
 
-* Code and test refactoring was performed to generally improve performance and code readability. (#1480, thanks @olivroy) 
-* The `gtsave()` function now returns the file path invisibly instead of `TRUE`. (#1478, thank you @olivroy)
+* Code and test refactoring was performed to generally improve performance and code readability. (#1480)
+
+* The `gtsave()` function now returns the file path invisibly instead of `TRUE`. (#1478)
 
-* Most functions now produce better error messages if not provided with a `gt_tbl` object. (#1504, c/o @olivroy)
+* Most functions now produce better error messages if not provided with a `gt_tbl` object. (#1504, #1624)
 
 * The URL formatting through `fmt_url()` has been improved by preventing link text breaking across lines (#1509). (#1537) 
+
 * We now remove some unnecessary newlines in the HTML text produced by `as_raw_html()`, which caused an issue when integrating **gt** tables into **blastula** email messages (#1506). (#1520)
 
 * The `tab_spanner_delim()` now lets you use `delim` strings longer than a single character (#1469). (#1513)

R/datasets.R

@@ -287,7 +287,7 @@
 #' \itemize{
 #' \item `"brie_carre"`: The Brie Carre Pizza (Brie Carre Cheese, Prosciutto,
 #'  Caramelized Onions, Pears, Thyme, Garlic)
-#' \item `"calabrese"`: The Calabrese Pizza (‘Nduja Salami, Pancetta,
+#' \item `"calabrese"`: The Calabrese Pizza ('Nduja Salami, Pancetta,
 #' Tomatoes, Red Onions, Friggitello Peppers, Garlic)
 #' \item `"soppressata"`: The Soppressata Pizza (Soppressata Salami, Fontina
 #' Cheese, Mozzarella Cheese, Mushrooms, Garlic)
@@ -527,14 +527,6 @@
 #' centimeters (cm) and kilograms (kg), respectively.}
 #' }
 #'
-#' @section Examples:
-#'
-#' Here is a glimpse at the data available in `peeps`.
-#'
-#' ```{r}
-#' dplyr::glimpse(peeps)
-#' ```
-#'
 #' @family datasets
 #' @section Dataset ID and Badge:
 #' DATA-8
@@ -544,7 +536,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "peeps"
 
@@ -576,7 +568,7 @@
 #' production. Here, 2-letter ISO 3166-1 country codes (set in uppercase) are
 #' used.}
 #' \item{run_time}{The run time of the film in hours and minutes. This is given
-#' as a string in the format '<x>h <y>m'.}
+#' as a string in the format `[x]h [y]m`.}
 #' \item{imdb_url}{The URL of the film's information page in the Internet Movie
 #' Database (IMDB).}
 #' }
@@ -598,7 +590,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "films"
 
@@ -656,14 +648,6 @@
 #' show `NA` values.}
 #' }
 #'
-#' @section Examples:
-#'
-#' Here is a glimpse at the data available in `metro`.
-#'
-#' ```{r}
-#' dplyr::glimpse(metro)
-#' ```
-#'
 #' @family datasets
 #' @section Dataset ID and Badge:
 #' DATA-10
@@ -719,7 +703,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "gibraltar"
 
@@ -965,7 +949,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "reactions"
 
@@ -1024,7 +1008,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "photolysis"
 
@@ -1085,7 +1069,7 @@
 #' }}
 #'
 #' @section Dataset Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 "nuclides"
 

R/export.R

@@ -1161,12 +1161,13 @@ as_word_tbl_body <- function(
 #'   The `plot` option determines whether the `gtable` object should be rendered
 #'   on the graphics device.
 #'
-#' @param text_grob
+#' @param text_grob *Function for drawing text*
 #'
 #'   `function` // *default:* `grid::textGrob`
 #'
-#'   A `function` used to draw text. Defaults to `grid::textGrob()` but can be
-#'   swapped to `gridtext::richtext_grob()` to better render HTML content.
+#'   A `function` which will be used to draw text. Defaults to
+#'   `grid::textGrob()` but can be swapped to `gridtext::richtext_grob()` to
+#'   better render HTML content.
 #'
 #' @return A `gtable` object.
 #'
@@ -1175,7 +1176,7 @@ as_word_tbl_body <- function(
 #' 13-6
 #'
 #' @section Function Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 #' @export
 as_gtable <- function(data, plot = FALSE, text_grob = grid::textGrob) {

R/format_data.R

@@ -1182,7 +1182,7 @@ fmt_integer <- function(
 #'   gt(rowname_col = "cmpd_name") |>
 #'   tab_header(title = "Gas-phase reactions of selected mercaptan compounds") |>
 #'   tab_spanner(
-#'     label = md("Reaction Rate Constant (298 K),<br>{{cm^3 molecules^–1 s^–1}}"),
+#'     label = md("Reaction Rate Constant (298 K),<br>{{cm^3 molecules^-1 s^-1}}"),
 #'     columns = ends_with("k298")
 #'   ) |>
 #'   fmt_chem(columns = cmpd_formula) |>
@@ -8562,7 +8562,7 @@ format_bins_by_context <- function(x, sep, fmt, context) {
 #' 3-18
 #'
 #' @section Function Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 #' @export
 fmt_tf <- function(
@@ -9286,7 +9286,7 @@ fmt_units <- function(
 #' 3-20
 #'
 #' @section Function Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 #' @export
 fmt_chem <- function(
@@ -10438,7 +10438,7 @@ add_anchor_attr <- function(
 #' 3-22
 #'
 #' @section Function Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 #' @export
 fmt_email <- function(
@@ -12186,7 +12186,7 @@ fmt_flag <- function(
 #' 3-25
 #'
 #' @section Function Introduced:
-#' *In Development*
+#' `v0.11.0`
 #'
 #' @export
 fmt_country <- function(
@@ -13036,11 +13036,11 @@ fmt_icon <- function(
 #' text_1a <- "
 #' ### This is Markdown.
 #'
-#' Markdown’s syntax is comprised entirely of
+#' Markdown's syntax is comprised entirely of
 #' punctuation characters, which punctuation
 #' characters have been carefully chosen so as
 #' to look like what they mean... assuming
-#' you’ve ever used email.
+#' you've ever used email.
 #' "
 #'
 #' text_1b <- "