get_summary_statistics#

data_morph.data.stats.get_summary_statistics(data: pd.DataFrame, with_median: bool) → SummaryStatistics[source]#

Calculate the summary statistics for the given set of points.

Parameters:

  • data (pandas.DataFrame) – A dataset with columns x and y.

  • with_median (bool) – Whether to include the median of x and y.

Returns:

Named tuple consisting of mean and standard deviations of x and y, along with the Pearson correlation coefficient between the two, and optionally, the median of x and y.

Return type:

SummaryStatistics