Local changes: Updated model training, removed debug instrumentation, and configuration improvements
This commit is contained in:
120
docs/user_manual/reporting.md
Normal file
120
docs/user_manual/reporting.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# Reporting Guide
|
||||
|
||||
Export your trading data and generate reports.
|
||||
|
||||
## Export Formats
|
||||
|
||||
### CSV Export
|
||||
|
||||
Export data to CSV for spreadsheet analysis:
|
||||
|
||||
- **Trades**: All executed trades
|
||||
- **Orders**: Order history
|
||||
- **Positions**: Current and historical positions
|
||||
- **Portfolio**: Portfolio snapshots
|
||||
- **Backtest Results**: Backtesting data
|
||||
|
||||
### PDF Reports
|
||||
|
||||
Generate comprehensive PDF reports:
|
||||
|
||||
- **Trading Report**: Summary of trading activity
|
||||
- **Performance Report**: Portfolio performance analysis
|
||||
- **Tax Report**: Tax reporting information
|
||||
|
||||
## Exporting Trades
|
||||
|
||||
1. Navigate to Reporting view
|
||||
2. Select "Export Trades"
|
||||
3. Choose date range:
|
||||
- **Start Date**: Beginning of period
|
||||
- **End Date**: End of period
|
||||
4. Select filters:
|
||||
- **Symbol**: Specific trading pair
|
||||
- **Paper Trading**: Include/exclude paper trades
|
||||
- **Exchange**: Specific exchange
|
||||
5. Choose format: CSV or PDF
|
||||
6. Click "Export"
|
||||
7. Save file
|
||||
|
||||
## Exporting Portfolio
|
||||
|
||||
1. Select "Export Portfolio"
|
||||
2. Choose data:
|
||||
- **Current Positions**: Open positions
|
||||
- **Position History**: Historical positions
|
||||
- **Performance Metrics**: Analytics data
|
||||
3. Select format
|
||||
4. Click "Export"
|
||||
5. Save file
|
||||
|
||||
## Tax Reporting
|
||||
|
||||
Generate tax reports for accounting:
|
||||
|
||||
1. Navigate to Reporting > Tax Report
|
||||
2. Select tax year
|
||||
3. Choose method:
|
||||
- **FIFO**: First In, First Out
|
||||
- **LIFO**: Last In, First Out
|
||||
- **Specific Identification**: Choose specific lots
|
||||
4. Configure settings:
|
||||
- **Currency**: Reporting currency
|
||||
- **Include Fees**: Include trading fees
|
||||
- **Include Paper Trades**: Optional
|
||||
5. Generate report
|
||||
6. Review and export
|
||||
|
||||
### Tax Report Contents
|
||||
|
||||
- **Realized Gains/Losses**: Profit/loss from closed trades
|
||||
- **Trade Summary**: All trades in period
|
||||
- **Cost Basis**: Purchase costs
|
||||
- **Proceeds**: Sale proceeds
|
||||
- **Gain/Loss**: Net gain or loss
|
||||
|
||||
## Scheduled Reports
|
||||
|
||||
Set up automatic report generation:
|
||||
|
||||
1. Navigate to Settings > Scheduled Reports
|
||||
2. Click "Add Schedule"
|
||||
3. Configure:
|
||||
- **Report Type**: Trades, Portfolio, Tax
|
||||
- **Frequency**: Daily, Weekly, Monthly
|
||||
- **Format**: CSV, PDF
|
||||
- **Email**: Optional email delivery
|
||||
4. Save schedule
|
||||
|
||||
## Performance Reports
|
||||
|
||||
Generate performance analysis reports:
|
||||
|
||||
- **Period Performance**: Returns for time period
|
||||
- **Risk Metrics**: Sharpe, Sortino, drawdown
|
||||
- **Trade Analysis**: Win rate, average win/loss
|
||||
- **Asset Performance**: Performance by asset
|
||||
- **Monthly Breakdown**: Performance by month
|
||||
|
||||
## Custom Reports
|
||||
|
||||
Create custom reports:
|
||||
|
||||
1. Select "Custom Report"
|
||||
2. Choose data sources:
|
||||
- Trades
|
||||
- Positions
|
||||
- Portfolio snapshots
|
||||
- Backtest results
|
||||
3. Select metrics to include
|
||||
4. Configure filters
|
||||
5. Generate report
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Regular Exports**: Export data regularly for backup
|
||||
2. **Tax Records**: Keep detailed tax reports
|
||||
3. **Performance Tracking**: Generate monthly performance reports
|
||||
4. **Data Backup**: Export before major updates
|
||||
5. **Record Keeping**: Maintain organized export files
|
||||
|
||||
Reference in New Issue
Block a user