File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change @@ -816,6 +816,21 @@ def missing_vals_tbl(data: FrameT | Any) -> GT:
816816 `ibis.expr.types.relations.Table`). Furthermore, using `missing_vals_tbl()` with these types of
817817 tables requires the Ibis library (`v9.5.0` or above) to be installed. If the input table is a
818818 Polars or Pandas DataFrame, the availability of Ibis is not needed.
819+
820+ The Missing Values Table
821+ ------------------------
822+ The missing values table shows the proportion of missing values in each column of the input
823+ table. The table is divided into sectors, with each sector representing a range of rows in the
824+ table. The proportion of missing values in each sector is calculated for each column. The table
825+ is displayed using the Great Tables API, which allows for further customization of the table's
826+ appearance.
827+
828+ To ensure that the table can scale to tables with many columns, each row in the reporting table
829+ represents a column in the input table. There are 10 sectors shown in the table, where the first
830+ sector represents the first 10% of the rows, the second sector represents the next 10% of the
831+ rows, and so on. Any sectors that are light blue indicate that there are no missing values in
832+ that sector. If there are missing values, the proportion of missing values is shown by a gray
833+ color (light gray for low proportions, dark gray to black for very high proportions).
819834 """
820835
821836 # Make a copy of the data to avoid modifying the original
You can’t perform that action at this time.
0 commit comments