twopirllc / pandas-ta

Technical Analysis Indicators - Pandas TA is an easy to use Python 3 Pandas Extension with 150+ Indicators
https://twopirllc.github.io/pandas-ta/
MIT License
5.32k stars 1.04k forks source link

Description for Each Indicator #584

Open chandraveshchaudhari opened 2 years ago

chandraveshchaudhari commented 2 years ago

I am very new to technical indicators, and there are over 200 indicators.

where can I find the documentation for each indicator with math? if documentation is not available, will this project accept my contribution?

twopirllc commented 2 years ago

Hello @chandraveshchaudhari,

There are a few ways listed under the Readme Help. Help with documentation is always welcome. 😎

Documentation with math has been removed starting with the development branch. Instead of including math in the help, links to the indicator source (which may or may not have math) have been provided. This helps keep documentation maintenance minimal.

What might be better instead, if your keen, is perhaps making a separate markdown file for the math of the indicators? What do you think?

Kind Regards, KJ

chandraveshchaudhari commented 2 years ago

Hello KJ,

I will create markdown for indicators description and share it as soon as possible.

Regards,

Chandravesh Chaudhari Financial Artificial Intelligence Research, CHRIST University (Bengaluru)

On Sat, 3 Sep, 2022, 12:11 am Kevin Johnson, @.***> wrote:

Hello @chandraveshchaudhari https://github.com/chandraveshchaudhari,

There are a few ways listed under the Readme Help https://github.com/twopirllc/pandas-ta#help. Help with documentation is always welcome. 😎

Documentation with math has been removed starting with the development branch. Instead of including math in the help, links to the indicator source (which may or may not have math) have been provided. This helps keep documentation maintenance minimal.

What might be better instead, if your keen, is perhaps making a separate markdown file for the math of the indicators? What do you think?

Kind Regards, KJ

— Reply to this email directly, view it on GitHub https://github.com/twopirllc/pandas-ta/issues/584#issuecomment-1235802747, or unsubscribe https://github.com/notifications/unsubscribe-auth/AIC4VLUN27SSQHIOBLHXJGLV4JC5NANCNFSM6AAAAAAQCP6LWI . You are receiving this because you were mentioned.Message ID: @.***>

twopirllc commented 2 years ago

@chandraveshchaudhari,

So as not to reinvent the wheel completely, I highly recommend checking out the details provided by Sierra Chart Indicators. A lot of them do have mathematical notation. Lastly no rush.

KJ

chandraveshchaudhari commented 2 years ago

Thanks, I'll check them out.

Regards,

Chandravesh Chaudhari Financial Artificial Intelligence Research, CHRIST University (Bengaluru)