PyFacts/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2022-02-17 10:50:48 +00:00
# Fincal
This module simplified handling of time-series data
## The problem
Time series data often have missing data points. These missing points mess things up when you are trying to do a comparison between two sections of a time series.
To make things worse, most libraries don't allow comparison based on dates. Month to Month and year to year comparisons become difficult as they cannot be translated into number of days. However, these are commonly used metrics while looking at financial data.
## The Solution
Fincal aims to simplify things by allowing you to:
* Compare time-series data based on dates
* Easy way to work around missing dates by taking the closest data points
* Completing series with missing data points using forward fill and backward fill
2022-03-12 04:53:22 +00:00
## Examples
## To-do
### Core features
2022-04-24 18:17:27 +00:00
- [x] Add __setitem__
2022-03-12 04:53:22 +00:00
- [ ] Create emtpy TimeSeries object
2022-04-02 02:15:59 +00:00
- [x] Read from CSV
2022-03-12 04:53:22 +00:00
- [ ] Write to CSV
- [ ] Convert to dict
- [ ] Convert to list of dicts
### Fincal features
2022-04-07 18:14:18 +00:00
- [x] Sync two TimeSeries
2022-04-02 02:15:59 +00:00
- [x] Average rolling return
- [x] Sharpe ratio
2022-03-12 04:53:22 +00:00
- [ ] Jensen's Alpha
- [ ] Beta
- [ ] Sortino ratio
- [ ] Correlation & R-squared
- [ ] Treynor ratio
- [x] Max drawdown
2022-05-31 15:48:55 +00:00
- [ ] Moving average
### Pending implementation
- [x] Use limit parameter in ffill and bfill
2022-04-07 18:14:18 +00:00
- [x] Implementation of ffill and bfill may be incorrect inside expand, check and correct
- [ ] Implement interpolation in expand