Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.95 KB

README.md

File metadata and controls

44 lines (30 loc) · 2.95 KB

Stock Labeling Software Documentation

Introduction

This software is designed to help users label stock charts quickly and efficiently using arrow keys. The arrow keys allow the user to label different parts of the chart as bullish, bearish, or sideways. The software allows the user to load new charts in .csv format and save labeled charts for future use.

Usage

To use this software, simply open the application in your web browser. Once the application is loaded, you can use the arrow keys to label different parts of the chart.

  • Arrow Up: Label chart as bullish (1)
  • Arrow Right: Label part of chart as sideways (0)
  • Arrow Down: Label part of chart as bearish (-1)

To load a new chart, click the "New Chart" button and select the .csv file containing the chart data in the format below. Once the chart is loaded, you can use the arrow keys to label it.

To save a labeled chart, click the "Save Chart" button. The labeled chart will be saved as a .csv file with an additional "Label" column that marks the direction of price.

To load a previously labeled chart, click the "Load Chart" button and select the .csv file containing the labeled chart data. The labeled chart will be loaded and you can continue labeling it.

Chart Data Format

The chart data should be in .csv format with the following columns:

timestamp open high low close volume close_time quote_av trades tb_base_av tb_quote_av ignore
2019-09-29 04:00:00 0.03103000 0.04147000 0.03103000 0.03986000 889029.20000000 1569729899999 34697.84143400 134 518219.10000000 20344.21056600 0
2019-09-29 04:05:00 0.03999000 0.04350000 0.03918000 0.04330000 1073974.40000000 1569730199999 43808.82939100 184 435028.60000000 17922.45386300 0

This format of data can be fetched from Binance API

The columns should be in the order listed above, and each row should represent a single candlestick/bar of the chart. For labeled charts, there should be an additional "Label" column that marks the direction of price (-1 for bearish, 0 for sideways, and 1 for bullish).

Limitations

Please note that this software is intended for educational and demonstration purposes only. It is not intended to provide financial or investment advice, and the labeling of charts should not be taken as a reliable indicator of future market performance. Always consult a qualified financial advisor before making investment decisions.

Project setup

npm install

Compiles and hot-reloads for development or use

npm run serve