search

karlwancl / Trady

Trady is a handy library for computing technical indicators, and it targets to be an automated trading system that provides stock data feeding, indicator computing, strategy building and automatic trading. It is built based on .NET Standard 2.0.
https://lppkarl.github.io/Trady
Apache License 2.0
546 stars 185 forks source link

More specific documentation and Trady test #82

Open isaacfilarski opened 5 years ago

isaacfilarski commented 5 years ago

Hello there,

I'm a new dotnet developer and I'm trying to make use of your Framework but i see very limited documentation. The only test I've been running is the benchmark and I find some things unclear.

I can't even find a tutorial of how Trady works on youtube there's only literally just what you offer.

Are there any plans on making more documentation?

Thanks for all :)

Greetings.

SariSultan commented 5 years ago

Yes, I have the same issue.

karlwancl commented 5 years ago

@IsaacFilarski @SariSultan Actually, it is discussed several months ago in #66 but the only current document is the readme file. For additional documentation, I would need to see if time is available as I'm quite busy on my work now.

irperez commented 5 years ago

What specifically would you like to see documentation on?

I started out feeling the same way, but after going through the unit tests, most of my questions were answered.

isaacfilarski commented 5 years ago

@lppkarl @irperez Well I would like to know in detail how the rules work. It would be very helpful if you someday take an hour to record a tutorial of you using Trady and explaining/covering as much as you can. I plan on posting my project with some limitations when I finish to help starters.

rossspaul commented 5 years ago

I agree, I'm struggling to do simple things like RSI(14) or ATR(20). Setting up the data properly and passing that data to these functions is very confusing. More examples on data setup (IOhlc) and calling the indicator functions please! Great library but hard to use.

MehdiAnis commented 4 years ago

What specifically would you like to see documentation on?

I started out feeling the same way, but after going through the unit tests, most of my questions were answered.

Test functions utilizes Extension methoids of Ienumerable like, candles.Cci(20). In my case I would like to see some example of calling CCI function directly -

var cciResults = new CommodityChannelIndexByTuple(Input, 14);

I do not know how to create the "Input" object. An example of creating IEnumerable<decimal High, decimal Low, decimal Close> object would be nice. Thanks.