sensortoolkit.calculate._regression_stats.join_stats

join_stats(hourly_stats, daily_stats, write_to_file=False, stats_path=None, stats_type='individual')[source]

Combine 1-hour and 24-hour regression statistics DataFrames.

Parameters
  • hourly_stats (pandas DataFrame) – DataFrame containing 1-hour averaged sensor vs. reference regression statistics, returned by call to regression_stats().

  • daily_stats (pandas DataFrame) – DataFrame containing 24-hour averaged sensor vs. reference regression statistics, returned by call to regression_stats().

  • write_to_file (bool, optional) – If True, the merged statistics dataframe will be written to a csv file. Defaults to False.

  • stats_path (str, optional) – The full path to the statistics directory where the dataset will be saved if write_to_file is True. Defaults to None.

  • stats_type (str, optional) – The type of regression statistics dataframes that are being joined (‘individual’ indicates individual sensor vs. reference regression, ‘average’ indicates sensor vs. intersensor average regression statistics)

Returns

DataFrame containing both 1-hour and 24-hour averaged statistics.

Return type

stats_df (pandas DataFrame)