Tutorials

[maread99]

Package needs .ipynb notebook tutorials (under doc/tutorials). There should be separate tutorials for:

• analysis.Analysis class
• analysis.Compare class
• trends subpackage

The tutorials should comprehensively cover the corresponding public API and include (although certainly not be limited to):

• creating a market-prices Prices instance (for example, a PricesYahoo instance) to pass to the constructor, explaining that the class will use this to get price data.
• passing 'period parameters' to define the analysis period, where these period parameters should be passed as kwargs. Any parameter of the market-prices get method can be included - they will all be passed through to that method to get the price data.
• the analysis tutorials should call the respective plot methods and the resulting guis should be comprehensively explained.
  • also cover the default volume subplot and adding custom subplots.