Distance Metric Plots¶

Plotting functions for distance metrics

Module Documentation¶

fitr.plotting.distance.distance_hist(X, group_labels, xlab='Distance', ylab='', normed=1, alpha=0.5, save_figure=False, figsize=None, figname='distance-hist.pdf')¶

Creates a histogram of within- and between-group distances.

Parameters:

group_labels : ndarray(size=n_labels): Vector of group labels for each participant represented
xlab : str: X-axis label
ylab : str: Y-axis label
normed : 0 or 1 (default=1): Whether the histogram should be normalized
alpha : float on interval (0, 1): Transparency of scatterplot points
save_figure : bool: Whether to save the figure
figsize : (optional) list: Controls figure size
figname : str: The name under which the plot should be saved

fitr.plotting.distance.distance_scatter(X, Y, group_labels=None, xlab='', ylab='', alpha=0.5, save_figure=False, figsize=None, figname='distance-scatter.pdf')¶

Creates a scatterplot between two distance metrics, demonstrating group separation, if any.

Parameters:	group_labels : (optional) xlab : str X-axis label ylab : str Y-axis label alpha : float on interval (0, 1) Transparency of scatterplot points save_figure : bool Whether to save the figure figsize : (optional) list Controls figure size figname : str The name under which the plot should be saved