Documentation forsplink.exploratory

completeness_chart(splink_dataframe_or_dataframes, cols=None, table_names_for_chart=None)

Generate a summary chart of data completeness (proportion of non-nulls) of columns in each of the input table or tables. By default, completeness is assessed for all columns in the input data.

Parameters:

Name	Type	Description	Default
splink_dataframe_or_dataframes	SplinkDataFrame | Sequence[SplinkDataFrame]	A single SplinkDataFrame or a sequence of SplinkDataFrames	required
cols	List[str]	List of column names to calculate completeness. If none, all columns will be computed. Default to None.	None
table_names_for_chart	List[str] | None	A list of names. Must be the same length as splink_dataframe_or_dataframes.	None

profile_columns(splink_dataframe_or_dataframes, column_expressions=None, top_n=10, bottom_n=10)

Profiles the specified columns of the dataframe initiated with the linker.

This can be computationally expensive if the dataframe is large.

For the provided columns with column_expressions (or for all columns if left empty) calculate: - A distribution plot that shows the count of values at each percentile. - A top n chart, that produces a chart showing the count of the top n values within the column - A bottom n chart, that produces a chart showing the count of the bottom n values within the column

This should be used to explore the dataframe, determine if columns have sufficient completeness for linking, analyse the cardinality of columns, and identify the need for standardisation within a given column.

Parameters:

Name	Type	Description	Default
)		A single SplinkDataFrame or a sequence of SplinkDataFrames	required
column_expressions	list	A list of strings containing the specified column names. If left empty this will default to all columns.	None
top_n	int	The number of top n values to plot.	10
bottom_n	int	The number of bottom n values to plot.	10

Returns:

Name	Type	Description
ProfileColumnsChart	ProfileColumnsChart	A SplinkChart describing the profiling charts.

Note

• The linker object should be an instance of the initiated linker.
• The provided column_expressions can be a list of column names to profile. If left empty, all columns will be profiled.
• The top_n and bottom_n parameters determine the number of top and bottom values to display in the respective charts.