gt_fa_rank_change

gt_fa_rank_change(
    gt,
    column,
    neutral_range=[0],
    icon_type='angles',
    color_up='green',
    color_down='red',
    color_neutral='grey',
    show_text=True,
    font_color='black',
    size=12,
)

Create rank change indicators in GT cells using FontAwesome icons.

This function represents numeric rank changes in table column(s) by displaying FontAwesome icons alongside the numeric values. Values greater than the maximum of neutral_range show up-pointing icons (e.g., arrows up), values less than the minimum of the range show down-pointing icons (e.g., arrows down), and values within the neutral range show neutral indicators (equals sign).

Parameters

gt : GT

A GT object to modify.

column : SelectExpr

The column containing numeric rank change values.

neutral_range : list[int] | int = [0]

A single number or list of numbers defining the neutral range. If a single number, only that exact value is considered neutral. If a list of numbers, any value within that range (inclusive) is considered neutral.

icon_type : Literal['angles', 'arrow', 'turn', 'chevron', 'caret'] = 'angles'

The type of FontAwesome icon to use for indicating direction. Options include "angles", "arrow", "turn", "chevron", and "caret".

color_up : str = 'green'

The color for positive (upward) rank changes.

color_down : str = 'red'

The color for negative (downward) rank changes.

color_neutral : str = 'grey'

The color for neutral rank changes (values within the neutral range).

show_text : bool = True

Whether to display the numeric value alongside the icon.

font_color : str = 'black'

The color for the numeric text displayed alongside the icons.

size : int = 12

The size of the font as well as the icon. Specificially it is both the width of the icon in pixels and the font size of the text.

Returns

: GT

A GT object with rank change indicators added to the specified column.

Example

from great_tables import GT
from great_tables.data import towny
import gt_extras as gte

mini_towny = towny.head(10)
gt = GT(mini_towny).cols_hide(None).cols_unhide("name")

columns = [
    "pop_change_1996_2001_pct",
    "pop_change_2001_2006_pct",
    "pop_change_2006_2011_pct",
]

for col in columns:
    gt = (
        gt
        .cols_align(columns=col, align="center")
        .cols_unhide(col)
        .cols_label({col: col[11:20]})

        .pipe(
            gte.gt_fa_rank_change,
            column=col,
            neutral_range=[-0.01, 0.01],
        )
    )

gt

name	1996_2001	2001_2006	2006_2011
Addington Highlands	-0.0111	0.0458	0.002
Adelaide Metcalfe	0.0067	-0.0044	-0.0341
Adjala-Tosorontio	0.0773	0.0608	-0.0086
Admaston/Bromley	-0.0046	-0.0382	0.0471
Ajax	0.1447	0.2226	0.2155
Alberton	-0.0691	0.0021	-0.0981
Alfred and Plantagenet	0.0334	0.0071	0.0626
Algonquin Highlands	0.083	0.0816	0.1063
Alnwick/Haldimand	0.0575	0.1008	0.0283
Amaranth	0.0928	0.0199	0.0307