mret
Monthly returns
Usage
mret [-p PERIOD] [-i {both,portfolio,benchmark}] [-g] [-s]
Parameters
| Name | Parameter | Description | Default | Optional | Choices |
|---|---|---|---|---|---|
| period | -p --period | Period to select start end of the year returns | all | True | 3y, 5y, 10y, all |
| instrument | -i --instrument | Whether to show portfolio or benchmark monthly returns. By default both are shown in one table. | both | True | both, portfolio, benchmark |
| graph | -g --graph | Plot the monthly returns on a heatmap | False | True | None |
| show_vals | -s --show | Show monthly returns on heatmap | False | True | None |