NEWS.md

In kcuilla/reactablefmtr: Streamlined Table Styling and Formatting for Reactable

reactablefmtr 2.1.0

New Features

icon_trend_indicator()

• Apply a down/up/no-change arrow icon to a column containing trend/change data

Enhancements

color_scales() & color_tiles()

• Expand the range of data within a column for better control of color assignments with min_value and max_value. For example, if your data contains values from 30 to 90, but you would like to assign color to the values as if the range was 0 to 100, you could do so by setting the min_value to 0 and the max_value to 100. This feature can provide more consistency in assigning colors across many columns.

react_sparkline() & react_sparkbar()

• More options added to the min and max values of the sparklines within min_value and max_value. A user can adjust the min and max value displayed for each row by providing either a numeric vector of length equal to the number of rows, a column name (as string) which holds the min/max values to use, a function which is applied to the min/max value of each row. Thank you to Tim Tiefenbach for contributing to this enhacement!

themes

• Added the ability to change the background color in each table theme with background_color

tooltip()

• Added 16 new features to tooltip(), allowing users the ability to: show/hide the name of the column, apply CSS styles, select one of four pre-set themes, display images within the tooltip, display values/text from other columns within the tooltip

Bug Fixes

• Fixed save_reactable() function to display as save_reactable() and not save_reactable_test()

reactablefmtr 2.0.0

New Features

add_legend() & add_icon_legend()

• Place a legend below a reactable table
• add_legend() can be used to display the color palette used within the table
• add_icon_legend() can be used to display the icon set used within icon_sets()
• The legends can be aligned to either the right or left of the table
• A title and/or footer can be added to the legend with title or footer
• The number of bins displayed within add_legend() can be adjusted with bins

background_img()

• Embed an image from the web into the background of a cell
• Unlike embed_img(), an image within background_img() will take up the entire contents of a cell
• background_img() can also be used in conjunction with embed_img()

bubble_grid()

• Build a customizable bubble grid chart
• The size of the bubbles are in relation to the values within each column - the bigger the value, the bigger the size of the bubble
• The shapes of the bubble can either be circles or squares specified by shape

cell_style()

• cell_style() can be used to customize the appearance of certain cells within a table. For example, if you wanted to display a particular value or set of values in a column as bold and in red text, you can do so by specifying either the row number or values themselves
• Custom styling options include: the color, size, style, and weight of the font within the cell, the color, width, and style of the border around the cell, the vertical and horizontal alignment within the cell, and the background color of the cell. Animation is also applied to cell_style() by default, but can be turned off by setting to 'none'

gauge_chart()

• Build a customizable gauge chart
• Show the minimum and maximum values of the column on the gauge by setting show_min_max to TRUE
• Many options that are available in data_bars() are available in gauge_chart()

google_font()

• Apply any font from Google Fonts https://fonts.google.com/ to a reactable table using google_font()

group_border_sort()

• Add a styled border beneath rows of specified groups on sort
• Credit to Greg Lin, creator of {reactable} for writing the JS function

group_merge_sort()

• Hide rows containing duplicate values on sort
• Credit to Greg Lin, creator of {reactable} for writing the JS function

html()

• Apply HTML attributes to to text within add_title(), add_subtitle(), and add_source() with the html() helper function

merge_column()

• Merge and arrange two columns together
• Can be used with both numeric and non-numeric columns
• Control the appearance of both the established column and the merged text with options such as text size, color, font weight, font style, and text decoration

pill_buttons()

• pill_buttons() can be used to surround text or numeric values in a colored pill button. It is similar to color_tiles() but is more condensed and round and the width of the pill dynamically adjusts based on the size of the text/values
• As with color_tiles(), color_scales(), and data_bars(), colors can be conditionally assigned from another column in the dataset and many of the other options available in color_tiles() are available in pill_buttons()
• Set box_shadow to TRUE to apply a box shadow to the buttons

sparklines

• Interactive sparklines can now be added to reactable tables via react_sparkline() and react_sparkbar()
• In order to use the sparklines, one must download the {dataui} package from GitHub (https://github.com/timelyportfolio/dataui)

tooltip

• Add a tooltip to cells (used with color_scales())
• Used within cell of reactable::colDef

Enhancements

add_title(), add_subtitle(), add_source()

• Added the ability to control the margin around each with margin()

animate

• The animation of data_bars() can now be controlled with animate. The animate parameter has also been added to color_scales(), color_tiles(), icon_sets(), and icon_assign(). The duration and timing function of the animation can be changed within animate or the animation can be turned off by setting it to 'none'. For available timing functions, see CSS Transitions

color_tiles()

• Set box_shadow to TRUE to apply a box shadow to the tiles

data_bars()

• Optionally force a range of values to display their text labels on the outside-end of the filled bars when the text_position is set to either "inside-end", "inside-base", or "center". This can be useful when the length of the filled data bars is too short to the text labels on the inside of the filled bars
• Control the size of the text labels with text_size
• Borders around the filled data bars can now be adjusted with the border_style, border_width, and border_color options
• Set box_shadow to TRUE to apply a box shadow to the bars

embed_img()

• The horizontal alignment within a cell can now be controlled with the horizontal_align option

icon_assign()

• The alignment of the icons within a column can now be changed to either left, right, or center with align_icons. Previously, icons could only be aligned to the left

icon_sets()

• Custom pre-selected icon sets can be assigned to values via icon_set. Options are "ski rating", "medals", and "batteries". Can be used with add_icon_legend()

Bug Fixes

• Fixed a bug that would not assign colors to values within color_scales(), color_tiles(), and data_bars() if there was no variance within the column
• Fixed the sparkline tooltip to allow all values to show clearly on hover
• Fixed issue with icon_assign() that displayed an error for columns containing all zeros

Other Modifications

• The default color of fill_color within data_bars() and icon_assign() has been changed to #67a9cf
• The default position of text_position within data_bars() has been changed from "outside-end" to "inside-end"
• Text is now centered vertically within data_bars() by default
• The size of the text within data_bars() can now be changed with text_size
• Added two additional themes: sanfran and no_lines
• Changed the underlying package in save_reactable() from {webshot2} to {webshot}. The {webshot} package is available on CRAN, so there is no need for users to manually download {webshot2} from GitHub
• The entire contents of a table can be vertically centered by setting centered to TRUE within any of the {reactablefmtr} themes

reactablefmtr 1.0.0

New Features

data_bars()

• data_bars() can now handle columns with positive and negative values. data_bars_pos_neg() is being depreciated
• data_bars() can create color gradients when more than two colors are provided with fill_gradient = TRUE. data_bars_gradient() is being depreciated
• The colors argument in data_bars() has been renamed to fill_color
• The height of the bars can now be adjusted with bar_height
• The default color of background has been changed from white to transparent
• data_bars() can now be either right-aligned or left-aligned with the align_bars argument by specifying either "left" or "right". By default, data_bars() are aligned left
• The placement of the labels can now be adjusted within data_bars() with the text_position argument. Labels can be placed either outside the filled bars with "outside-end" or "outside-base", inside the filled bars with "inside-end", "inside-base", or "center", or labels can be hidden with "none". By default, labels are placed on the "outside-end" of the filled bars
• The color of the labels can be changed by using the text_color argument. The default color is black
• Labels can be shown in bold text with the bold_text logical argument
• If labels are placed inside the filled bars and the bars are filled with a dark color, the color of the labels will automatically change to white rather than the default black with the brighten_text logical argument. The color of brighten_text_color can be changed to any color
• The colors for the fill of the data_bars() can be provided from another column by referencing the name of the column containing the colors within fill_color_ref. This is useful for assigning conditions or assigning colors to the bars for different groups within the dataset
• The opacity of the fill color can be adjusted with fill_opacity by providing a value between 0 and 1 (from transparent to opaque)
• The maximum width of the fill of data_bars() can be adjusted with the max_value argument. By default, the maximum width is the maximum value contained in the column. Ex. if showing percentages and the maximum value is 80%, by default, 80% will look 100% filled (since it's 80% out of 80%). By changing max_value = 1 (or max_value = 100 depending on how your percentages are displayed), it will shrink the 80% to be relative to 100%. If a maximum value is provided, a minimum value can also be set with min_value
• Icons can now be added to the data bars with either icon or icon_ref
• By default, the color of the icon is inherited from the fill color of the data bars, but can be changed with icon_color or icon_color_ref
• Images can now be added to the data bars with either img or img_ref

color_scales() & color_tiles()

• Colors can be provided from another column by referencing the name of the column containing the colors within color_ref. This is useful for assigning conditions or assigning colors to the bars for different groups within the dataset. If color_ref is used within reactable::defaultColDef, every column in the dataset, regardless of whether they are numeric or not, will receive the conditional colors.
• Default colors have been changed from red-white-blue to blue-white-orange
• The opacity of the background colors can be adjusted with opacity by providing a value between 0 and 1
• The color of the values can be changed by using the text_color argument. The default color is black
• Values can be shown in bold text with the bold_text logical argument
• brighten_values has been renamed to brighten_text
• The color of the values in cells that have brighten_values applied can be changed with brighten_text_color. The default color is white
• Values can now be hidden by setting show_text to FALSE

embed_img()

• Labels from another column can now be positioned above, below, or to the left of the embedded image. Previously, the labels could only positioned to the right of the image

icon_assign()

• The size of the icons can now be adjusted using icon_size
• The opacity of fill_color and empty_color can be adjusted with fill_opacity and empty_opacity respectively, by providing a value between 0 and 1 (from transparent to opaque)
• In addition to optionally showing values to the left or right of the icons, values can now also be placed above or below the icons in show_values

icon_sets()

• Can now use any number of icons and colors to assign to data. Previously only three icons and colors could be used.
• Icons can be positioned to the right, left, above, below, or over the values with icon_position. Previously icons could only be positioned to the right of the values
• The size of the icons can now be adjusted using icon_size
• Default colors have been changed from red-white-blue to blue-grey-orange
• The opacity of the icon colors can be adjusted with opacity by providing a value between 0 and 1 (from transparent to opaque)
• Icons can be provided from another column by referencing the name of the column containing the icons within icon_ref
• Icon colors can be provided from another column by referencing the name of the column containing the colors within icon_color_ref

save_reactable()

• Reactable tables can now be saved as static .png files or dynamic .html files using save_reactable()
• If the reactable table was created in a .Rmd file and additional CSS styling are applied, reference the name of either the .Rmd file containing the reactable table or the .html file of the reactable table to save an image of the table
• Note: this feature requires the {webshot2} package which can be downloaded from https://github.com/rstudio/webshot2.

add_title(), add_subtitle(), add_source()

• You can now easily add a title and/or a subtitle above any reactable table with add_title() and add_subtitle()
• You can also add a source below a reactable table with add_source()
• Additional customization options such as adjusting the font size, font color, and font family are also available

themes

Added 24 new table themes, including:

• Bootstrap-inspired themes: cerulean, cosmo, cyborg, darkly, flatly, journal, lux, minty, sandstone, slate, spacelab, and superhero
• News/sports-inspired themes: espn, fivethirtyeight, nytimes, and pff
• Other custom themes: clean, default, hoverdark, hoverlight, midnight, midnightblue, sunrise, and void

Breaking Changes

• The colors argument in data_bars() has been renamed to fill_color
• The brighten_values argument in color_scales() and color_tiles() has been renamed to brighten_text

reactablefmtr 0.2.0

New Features

• Data bars can now accept gradient colors by using data_bars_gradient()
• Columns can now be conditionally formatted with color_tiles()
• Images from the web can now be embedded into a column using embed_img()
• Columns can now be formatted using formatters from the scales package using the number_fmt() option
• By default, values displayed with the color_scales() and color_tiles() packages will automatically be shown in black or white color depending on the saturation of the background color of the cell. This option can be turned off by setting bright_values = FALSE
• Data bars are now animated on sort when using any of the three data bars formatters (data_bars(), data_bars_pos_neg(), data_bars_gradient())
• Conditional colors can now be applied to values in relation to the entire dataset or to a group of columns by providing column names or column positions with the span option within color_scales() and color_tiles(). Special thanks to June Chao for the contribution for this feature.
• Icons can be assigned to each value in a column by using icon_assign()

Bug Fixes

• An issue where aligning values while using data_bars() did not always align properly has been fixed

Other

• Due to the addition of number_fmt() which allows for the use of formatters from the scales package, the add_plus_sign() formatter will be retired in the next CRAN release as well as the commas option in the data_bars() formatter, and the percent option in the data_bars_pos_neg() and icon_sets() formatters

reactablefmtr 0.1.0

• Initial release to CRAN

kcuilla/reactablefmtr documentation built on Jan. 13, 2023, 11:36 p.m.