GT.sub_missing

GT.sub_missing(self, columns=None, rows=None, missing_text=None)

Substitute missing values in the table body.

Wherever there is missing data (i.e., None values) customizable content may present better than the standard representation of missing values that would otherwise appear. The sub_missing() method allows for this replacement through its missing_text= argument. And by not supplying anything to missing_text=, an em dash will serve as a default indicator of missingness.

Parameters

Name	Type	Description	Default
columns	SelectExpr	The columns to target. Can either be a single column name or a series of column names provided in a list.	None
rows	int | list[int] | None	In conjunction with columns=, we can specify which of their rows should be scanned for missing values. The default is all rows, resulting in all rows in all targeted columns being considered for this substitution. Alternatively, we can supply a list of row indices.	None
missing_text	str | Text | None	The text to be used in place of missing values in the rendered table. We can optionally use the md() or html() helper functions to style the text as Markdown or to retain HTML elements in the text.	None

Returns

Type	Description
GT	The GT object is returned. This is the same object that the method is called on so that we can facilitate method chaining.

Examples

Using a subset of the exibble dataset, let’s create a new table. The missing values in two selections of columns will be given different variations of replacement text (across two separate calls of sub_missing()).

from great_tables import GT, md, html, exibble
import polars as pl
import polars.selectors as cs

exibble_mini = pl.from_pandas(exibble).drop("row", "group", "fctr").slice(4, 8)

(
    GT(exibble_mini)
    .sub_missing(
        columns=["num", "char"],
        missing_text="missing"
    )
    .sub_missing(
        columns=cs.contains(("date", "time")) | cs.by_name("currency"),
        missing_text="nothing"
    )
)

num	char	date	time	datetime	currency
5550.0	missing	2015-05-15	17:55	2018-05-05 04:00	1325.81
missing	fig	2015-06-15	nothing	2018-06-06 16:11	13.255
777000.0	grapefruit	nothing	19:10	2018-07-07 05:22	nothing
8880000.0	honeydew	2015-08-15	20:20	nothing	0.44