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

Need to add examples for plot_candlestick_chart function in pyalgotrading/utils/func.py #14

Open
Blackfury7 opened this issue Dec 25, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@Blackfury7
Copy link
Contributor

I am trying to use this function to plot candlesticks for my dataframe.
But the format of arguments is not mentioned properly.
First I was stuck at plot_type argument. To understand it I had to find the code in the repo where it was defined.
Now ,I am finding it difficult to understand the format of indicators required for this function.

So, there is need of examples and additional information on arguments.

@Blackfury7
Copy link
Contributor Author

Blackfury7 commented Dec 25, 2022

I would like to work on this.
Can you assign this to me?
@pushpakdagade
@guanidene

@pushpakdagade
Copy link
Contributor

Hi @Blackfury7, I didn't get your exact problem here. Kindly elaborate. Alternatively, you are free to raise a PR and if it adds value, I will merge it.

@Blackfury7
Copy link
Contributor Author

Blackfury7 commented Dec 26, 2022

I wanted to plot the candlestick plot of Dataframe data (HIGH, LOW, CLOSE, OPEN) and 'indicator'. I tried using the "plot_candlestick_chart" function in pyalgotrading/utils/func.py, but the datatypes and formats of the arguments of the "plot_candlestick_chart" function were not mentioned clearly in the documentation.
There were no examples also, like this type of data this function takes as argument.
I faced difficulty in using the "plot_candlestick_chart".

Then I had to look into the code base of pyalgotrading to properly understand the "plot_candlestick_chart" function and use it.

So, there is requirement of few examples in the documentation to show clarity on how to use this plot_candlestick_chart or other plot algorithms in pyalgotrading.

@pushpakdagade pushpakdagade added the documentation Improvements or additions to documentation label Oct 4, 2023
@pushpakdagade
Copy link
Contributor

@Blackfury7 are you open to making contributions to help create doc here? We'll support you for the same.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants