Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
aravindhebbali committed Feb 6, 2024
1 parent ac13c05 commit 858e321
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 36 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To retrieve data from Yahoo Finance for a single stock, create an instance of th
aapl <- Ticker$new('aapl')
# get historical market data
aapl$get_history(start = '2024-01-15', interval = '1d')
aapl$get_history(start = '2024-01-20', interval = '1d')
```

### Index
Expand All @@ -60,13 +60,13 @@ To retrieve data from Yahoo Finance for an index, create an instance of the `Ind
nifty_50 <- Index$new('^NSEI')
# get historical data
nifty_50$get_history(start = '2024-01-15', interval = '1d')
nifty_50$get_history(start = '2024-01-20', interval = '1d')
```

### Currency

```{r currency}
currency_converter('GBP', 'USD', '2024-01-15', '2023-08-04')
currency_converter('GBP', 'USD', '2024-01-20', '2024-01-30')
```

## IMPORTANT LEGAL DISCLAIMER
Expand Down
60 changes: 28 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,16 @@ an argument:
aapl <- Ticker$new('aapl')

# get historical market data
aapl$get_history(start = '2024-01-15', interval = '1d')
#> date volume high low open close adj_close
#> 1 2024-01-16 14:30:00 65603000 184.26 180.93 182.16 183.63 183.63
#> 2 2024-01-17 14:30:00 47317400 182.93 180.30 181.27 182.68 182.68
#> 3 2024-01-18 14:30:00 78005800 189.14 185.83 186.09 188.63 188.63
#> 4 2024-01-19 14:30:00 68741000 191.95 188.82 189.33 191.56 191.56
#> 5 2024-01-22 14:30:00 60133900 195.33 192.26 192.30 193.89 193.89
#> 6 2024-01-23 14:30:00 42355600 195.75 193.83 195.02 195.18 195.18
#> 7 2024-01-24 14:30:00 53631300 196.38 194.34 195.42 194.50 194.5
#> 8 2024-01-25 14:30:00 54822100 196.27 193.11 195.22 194.17 194.17
#> 9 2024-01-26 14:30:00 44553400 194.76 191.94 194.27 192.42 192.42
#> 10 2024-01-29 14:30:00 47042500 192.20 189.58 192.01 191.73 191.73
aapl$get_history(start = '2024-01-20', interval = '1d')
#> date volume high low open close adj_close
#> 1 2024-01-22 14:30:00 60133900 195.33 192.26 192.30 193.89 193.89
#> 2 2024-01-23 14:30:00 42355600 195.75 193.83 195.02 195.18 195.18
#> 3 2024-01-24 14:30:00 53631300 196.38 194.34 195.42 194.50 194.5
#> 4 2024-01-25 14:30:00 54822100 196.27 193.11 195.22 194.17 194.17
#> 5 2024-01-26 14:30:00 44553400 194.76 191.94 194.27 192.42 192.42
#> 6 2024-01-29 14:30:00 47145600 192.20 189.58 192.01 191.73 191.73
#> 7 2024-01-30 14:30:00 55859400 191.80 187.47 190.94 188.04 188.04
#> 8 2024-01-31 14:30:00 55396700 187.10 184.35 187.04 184.40 184.4
```

### Index
Expand All @@ -61,31 +59,29 @@ the `Index` class by passing the index symbol as an argument:
nifty_50 <- Index$new('^NSEI')

# get historical data
nifty_50$get_history(start = '2024-01-15', interval = '1d')
#> date volume high low open close adj_close
#> 1 2024-01-15 03:45:00 345500 22115.55 21963.55 22053.15 22097.45 22097.45
#> 2 2024-01-16 03:45:00 292400 22124.15 21969.80 22080.50 22032.30 22032.3
#> 3 2024-01-17 03:45:00 456000 21851.50 21550.45 21647.25 21571.95 21571.95
#> 4 2024-01-18 03:45:00 387300 21539.40 21285.55 21414.20 21462.25 21462.25
#> 5 2024-01-19 03:45:00 343100 21670.60 21575.00 21615.20 21622.40 21622.4
#> 6 2024-01-22 03:45:00 NA NA NA NA NA NULL
#> 7 2024-01-23 03:45:00 449700 21750.25 21192.60 21716.70 21238.80 21238.8
#> 8 2024-01-24 03:45:00 407500 21482.35 21137.20 21185.25 21453.95 21453.95
#> 9 2024-01-25 03:45:00 418100 21459.00 21247.05 21454.60 21352.60 21352.6
#> 10 2024-01-29 03:45:00 376700 21763.25 21429.60 21433.10 21737.60 21737.6
#> 11 2024-01-30 07:40:04 0 21813.05 21655.25 21775.75 21674.95 21674.95
nifty_50$get_history(start = '2024-01-20', interval = '1d')
#> date volume high low open close adj_close
#> 1 2024-01-23 03:45:00 449700 21750.25 21192.60 21716.70 21238.80 21238.8
#> 2 2024-01-24 03:45:00 407500 21482.35 21137.20 21185.25 21453.95 21453.95
#> 3 2024-01-25 03:45:00 418100 21459.00 21247.05 21454.60 21352.60 21352.6
#> 4 2024-01-29 03:45:00 376700 21763.25 21429.60 21433.10 21737.60 21737.6
#> 5 2024-01-30 03:45:00 375100 21813.05 21501.80 21775.75 21522.10 21522.1
#> 6 2024-01-31 03:45:00 410600 21741.35 21448.85 21487.25 21725.70 21725.7
#> 7 2024-02-01 09:02:14 0 21832.95 21658.75 21780.65 21718.45 21718.45
```

### Currency

``` r
currency_converter('GBP', 'USD', '2024-01-15', '2023-08-04')
#> Yahoo Finance API request failed
#> Status: 400
#> Type: Client error
#> Mesage:
#> Description:
#>
currency_converter('GBP', 'USD', '2024-01-20', '2024-01-30')
#> date high low open close volume adj_close
#> 1 2024-01-22 1.273075 1.268826 1.270083 1.269986 0 1.269986
#> 2 2024-01-23 1.274714 1.265534 1.270826 1.270696 0 1.270696
#> 3 2024-01-24 1.277368 1.268681 1.269422 1.269197 0 1.269197
#> 4 2024-01-25 1.274226 1.269293 1.271844 1.271876 0 1.271876
#> 5 2024-01-26 1.275754 1.267732 1.270696 1.270826 0 1.270826
#> 6 2024-01-29 1.271941 1.266320 1.269712 1.269761 0 1.269761
#> 7 2024-01-30 1.272135 1.264286 1.271407 1.271326 0 1.271326
```

## IMPORTANT LEGAL DISCLAIMER
Expand Down
2 changes: 1 addition & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

0 errors | 0 warnings | 1 note

There was 1 note about possibly invalid URL.
This is a re-submission. We have ensured that suggested packages are only used conditionally. There was 1 note about possibly invalid URL.

0 comments on commit 858e321

Please sign in to comment.