metadata_pairplot

pylluminator.visualizations.metadata_pairplot(input_data: Samples | DataFrame, columns: list[str] | None = None, hue: str | None = None, kind='reg', corner=True, height=1.5, save_path=None, **kwargs) → None

Build a pair plot from the samples’ sample sheet. Just a very simple wrapper around sns.pairplot()

Parameters:

• input_data (Samples | pd.DataFrame) – Samples object to analyze the sample sheet of, or a sample sheet dataframe directly

• columns (list[str] | None) – list of columns to use for the correlation. If None, use all columns. Default: None

• hue (str | None) – column name to use for the color of the points and categorize them for regression. Default: None

• kind (str) – kind of plot to use. Possible values: ‘scatter’, ‘kde’, ‘hist’, ‘reg’. Default: ‘reg’

• corner (bool) – if True, plot only the lower triangle of the matrix. Default: True

• height (float) – height of each facet in inches. Default: 1.5

• save_path (str | None) – if set, save the graph to save_path. Default: None

• kwargs – additional arguments to pass to sns.pairplot()

Returns:

None