From 6833710e66967948c711614108f8f5b3c7f16294 Mon Sep 17 00:00:00 2001 From: David Brazda Date: Thu, 10 Oct 2024 10:42:40 +0200 Subject: [PATCH] minor fix --- README.md | 4 ++-- setup.py | 2 +- ttools/vbtutils.py | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7337d4c..6fb1c33 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Example usage: ```python from ttools import AnchoredIndicator -mom_standard = vbt.indicator("talib:MOM").run(t1data.data["BAC"].close) -mom_anchored_d = AnchoredIndicator("talib:MOM", anchor='D').run(t1data.data["BAC"].close) +mom = vbt.indicator("talib:MOM").run(t1data.data["BAC"].close, timeperiod=10, skipna=True) #standard indicator +mom_anch_d = AnchoredIndicator("talib:MOM", anchor='D').run(t1data.data["BAC"].close, timeperiod=10, skipna=True) #anchored to D ``` diff --git a/setup.py b/setup.py index 41ad8ab..5c54531 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages setup( name='ttools', - version='0.1.2', + version='0.1.3', packages=['ttools'], install_requires=[ 'vectorbtpro', diff --git a/ttools/vbtutils.py b/ttools/vbtutils.py index 5ff7192..baad72c 100644 --- a/ttools/vbtutils.py +++ b/ttools/vbtutils.py @@ -11,8 +11,8 @@ class AnchoredIndicator: Parameters: - indicator_name: str, the name of the vectorbt indicator. - - anchor: str, 'D' for day, 'H' for hour, 'T' for minute (default is 'D'). - Any valid frequency string ('D', 'H', 'T', 'W', etc.). can be used as it uses pd.Grouper(freq=anchor) + - anchor: str, 'D' for day, 'h' for hour, 'min' for minute (default is 'D'). + Any valid frequency string ('D', 'h', 'min', 'W', etc.). can be used as it uses pd.Grouper(freq=anchor) see https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases """ self.indicator_name = indicator_name @@ -26,8 +26,8 @@ class AnchoredIndicator: Parameters: - data: pd.Series or pd.DataFrame, the input data series or dataframe (e.g., close prices). - - anchor: str, 'D' for day, 'H' for hour, 'T' for minute (default is 'D'). Override for anchor on the instance. - Any valid frequency string ('D', 'H', 'T', 'W', etc.). can be used as it uses pd.Grouper(freq=anchor) + - anchor: str, 'D' for day, 'h' for hour, 'min' for minute (default is 'D'). Override for anchor on the instance. + Any valid frequency string ('D', 'h', 'min', 'W', etc.). can be used as it uses pd.Grouper(freq=anchor) see https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases - *args, **kwargs: Arguments and keyword arguments passed to the indicator. """