Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/ccf #2122

Merged
merged 5 commits into from
Jan 19, 2024
Merged

Feat/ccf #2122

merged 5 commits into from
Jan 19, 2024

Conversation

dennisbader
Copy link
Collaborator

Summary

  • adds darts.utils.statistics.plot_ccf: the Cross Correlation Function (CCF) similar to the Autocorrelation Function (ACF). CCF can be used to compute the corrolation between a time series (e.g. target series) and the of lagged values of another time series (e.g. covariates series).

@codecov-commenter
Copy link

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (4362df2) 93.92% compared to head (175f293) 93.93%.

Files Patch % Lines
darts/utils/statistics.py 94.44% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2122   +/-   ##
=======================================
  Coverage   93.92%   93.93%           
=======================================
  Files         135      135           
  Lines       13335    13356   +21     
=======================================
+ Hits        12525    12546   +21     
  Misses        810      810           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@madtoinou madtoinou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one very minor comment about the docstring

) -> None:
"""
Plots the Cross Correlation Function (CCF) between `ts` and `ts_other`, highlighting it at lag `m`, with
corresponding significance interval.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to the documentation of statsmodels.ccovf?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thanks

@dennisbader dennisbader merged commit 8b77a69 into master Jan 19, 2024
9 checks passed
@dennisbader dennisbader deleted the feat/ccf branch January 19, 2024 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants