Skip to content

Commit bba8c39

Browse files
authored
Update README.md
1 parent 5c3f236 commit bba8c39

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88
The {reactablefmtr} package simplifies and enhances the styling and formatting of tables built with the {reactable} **R** package. The {reactablefmtr} package provides many conditional formatters that are highly customizable and easy to use.
99

1010
* **Conditionally format tables** with [color scales](https://kcuilla.github.io/reactablefmtr/articles/color_scales.html), [color tiles](https://kcuilla.github.io/reactablefmtr/articles/color_tiles.html), and [data bars](https://kcuilla.github.io/reactablefmtr/articles/data_bars_development.html). Assign icons from [Font Awesome](https://fontawesome.com/icons?d=gallery&p=2) with [icon assign](https://kcuilla.github.io/reactablefmtr/articles/icon_assign.html) and [icon sets](https://kcuilla.github.io/reactablefmtr/articles/icon_sets.html).
11+
1112
* **Custom table themes** that can [easily](https://kcuilla.github.io/reactablefmtr/articles/themes.html) be applied to any {reactablefmtr} or {reactable}.
13+
1214
* **Embed images** directly from the web into your [table](https://kcuilla.github.io/reactablefmtr/articles/embed_img.html).
15+
1316
* **Save tables** as static PNG files or as interactive HTML files.
1417

1518
The {reactablefmtr} package was built using a combination of **R**, **CSS**, and **HTML** in order to allow any level of **R** user to build highly customizable and stylish tables without having to learn additional programming languages.
@@ -32,14 +35,14 @@ remotes::install_github("kcuilla/reactablefmtr")
3235

3336
## Examples
3437

35-
## Data Bars
38+
### Data Bars
3639

3740
Use `data_bars()` to assign horizontal bars to each row. There are many ways to [customize](https://kcuilla.github.io/reactablefmtr/reference/data_bars.html) the look of `data_bars()`, including the alignment of the bars, the posiiton of the text labels, and the ability to add icons and images to the bars. See the [tutorial](https://kcuilla.github.io/reactablefmtr/articles/data_bars_development.html) for customization examples.
3841

3942
![](man/figures/data_bars_animated_demo.gif)
4043

4144

42-
## Color Scales
45+
### Color Scales
4346

4447
Use `color_scales()` to assign conditional colors to cells based on their value. The color of the text in the cells automatically adjusts based on the shade of the cell color, allowing the use of dark-colored palettes (such as viridis::magma shown below).
4548

@@ -59,6 +62,7 @@ reactable(
5962

6063
<img src="man/figures/BB295375-698D-48C1-9275-AEEC3CB8443F.jpeg" align="center" width = "90%" height = "90%" />
6164

65+
6266
By default, colors are conditionally assigned to values within each column, but can also be assigned to row-wise data as shown below. See the [tutorial](https://kcuilla.github.io/reactablefmtr/articles/color_scales.html) for more examples.
6367

6468
```{r}
@@ -77,7 +81,8 @@ reactable(
7781

7882
<img src="man/figures/EE85DA35-1A23-4A86-86F5-8C934CC75980.jpeg" align="center" width = "90%" height = "90%" />
7983

80-
## Color Tiles
84+
85+
### Color Tiles
8186

8287
A similar formatter to `color_scales()` is `color_tiles()`. Numbers can be formatted using any formatter from the {scales} package, just like how they are in {ggplot2}. See the [tutorial](https://kcuilla.github.io/reactablefmtr/articles/color_tiles.html) for customization options.
8388

@@ -91,7 +96,8 @@ reactable(
9196
```
9297
<img src="man/figures/README_color_tiles_bright_values.PNG" align="center" width = "80%" height = "80%"/>
9398

94-
## Icon Assign
99+
100+
### Icon Assign
95101

96102
Use `icon_assign()` to assign icons to values from the [Font Awesome](https://fontawesome.com/icons?d=gallery&p=2) library. Multiple customization options are available, such as bucketing values and show/hide values next to the icons. See [tutorial](https://kcuilla.github.io/reactablefmtr/articles/icon_assign.html) for more options.
97103

@@ -109,6 +115,7 @@ reactable(
109115

110116
<img src="man/figures/5E26F646-AE47-4044-B01D-6BEBF28DD08B.jpeg" align="center" width = "90%" height = "90%"/>
111117

118+
112119
## Custom Themes
113120

114121
Within {reactablefmtr}, there are 24+ custom table themes. The themes include [bootstrap](https://bootswatch.com/) themes, themes inspired by news/sports sites such as The New York Times, FiveThirtyEight, and ESPN, and other themes made specifically for {reactablefmtr}. The themes can be applied easily to tables by simply referencing the theme name. Additional customization options, such as changing the font size, font color, etc. are also [available](https://kcuilla.github.io/reactablefmtr/articles/themes.html).
@@ -125,6 +132,7 @@ data %>%
125132

126133
<img src="man/figures/43042890-A054-49D2-B066-8E329BE90ACA.jpeg" align="center" width = "90%" height = "90%"/>
127134

135+
128136
## Save Static or Interactive Tables
129137

130138
{reactablefmtr} or {reactable} tables can be saved directly to a file as a static PNG image or interactive HTML file with `save_reactable()`.

0 commit comments

Comments
 (0)