Duncan McDonald, Peter Bell, Miguel Roberts, Matthew Chan
Table of Contents
Welcome to OCamlStocks! This program aims to enable the user to research the effectiveness of Reddit as an Investment Advisor. This is built through multiple different steps:
Scraping and Parsing Reddit: The program can scrape subreddits looking for any stock tickers and then storing data about how that stock is mentioned.
Scraping Yahoo Finance: The program scrapes Yahoo Finance to factor past data and recommendation ratings for stocks into the formula.
Stock Algorithm: Our algorithm aims to combine various features about a subreddit post and Yahoo's recommendation rating.
The above equation is our algorithm.
x,y, w1, and w2 are constants to weight the effects of each of the variables
Optimizer: The optimizer determines the ideal constants for a day by performing uniform distrubution testing on one day and then determining which of these had the best resulting net gain in income the next day.
Further details of included features are described in the built in help instructions and menu descriptions within the program.
opam install . --deps-only
to install dependencies using opammake
or make bot
to run the bot/programmake build
to build projectmake utop
to open the project in utopmake test
to run ounit test casesmake clean
to remove the old _build folder and docsmake zip
to make a zip file of the projectmake install
to be walked through an install process (Further details are in Install.md)make docs
to make the documentation