Skip to content

Commit 8820c27

Browse files
committed
update readme
1 parent 3866583 commit 8820c27

File tree

3 files changed

+18
-33
lines changed

3 files changed

+18
-33
lines changed

README.Rmd

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ knitr::opts_chunk$set(
1717

1818
<!-- badges: start -->
1919
[![CRAN Status](https://www.r-pkg.org/badges/version/ichimoku?color=00008b)](https://CRAN.R-project.org/package=ichimoku)
20-
[![R-multiverse status](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fcommunity.r-multiverse.org%2Fapi%2Fpackages%2Fichimoku&query=%24.Version&label=r-multiverse)](https://community.r-multiverse.org/ichimoku)
21-
[![ichimoku status badge](https://shikokuchuo.r-universe.dev/badges/ichimoku?color=a4d1eb)](https://shikokuchuo.r-universe.dev/ichimoku)
20+
[![ichimoku status badge](https://shikokuchuo.r-universe.dev/badges/ichimoku)](https://shikokuchuo.r-universe.dev/ichimoku)
2221
[![R-CMD-check](https://github.com/shikokuchuo/ichimoku/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/shikokuchuo/ichimoku/actions/workflows/R-CMD-check.yaml)
2322
[![codecov](https://codecov.io/gh/shikokuchuo/ichimoku/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/ichimoku)
2423
[![DOI](https://zenodo.org/badge/367928545.svg)](https://zenodo.org/badge/latestdoi/367928545)
@@ -28,6 +27,14 @@ Visualization and Tools for Ichimoku Kinko Hyo Strategies
2827

2928
An implementation of 'Ichimoku Kinko Hyo', also commonly known as 'cloud charts'. Static and interactive visualizations with tools for creating, backtesting and development of quantitative 'ichimoku' strategies. As described in Sasaki (1996, ISBN:4925152009), the technique is a refinement on candlestick charting, originating from Japan and now in widespread use in technical analysis worldwide. Translating as 'one-glance equilibrium chart', it allows the price action and market structure of financial securities to be determined 'at-a-glance'. Incorporates an interface with the OANDA fxTrade API <https://developer.oanda.com/> for retrieving historical and live streaming price data for major currencies, metals, commodities, government bonds and stock indices.
3029

30+
## Installation
31+
32+
Install ichimoku from CRAN:
33+
34+
``` r
35+
install.packages("ichimoku")
36+
```
37+
3138
## Quick Start
3239

3340
```{r load}
@@ -94,20 +101,6 @@ Long-form documentation links:
94101

95102
{ 4 } [The OANDA fxTrade API](https://shikokuchuo.net/ichimoku/articles/xoanda.html)
96103

97-
## Installation
98-
99-
Install the latest release from CRAN or R-multiverse:
100-
101-
``` r
102-
install.packages("ichimoku")
103-
```
104-
105-
The current development version is available from R-universe:
106-
107-
``` r
108-
install.packages("ichimoku", repos = "https://shikokuchuo.r-universe.dev")
109-
```
110-
111104
## References
112105

113106
Sasaki, H. 佐々木 英信 (1996), *一目均衡表の研究 [ichimoku kinkouhyou no kenkyuu]*. Tokyo, Japan: Toushi Radar.

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@
77

88
[![CRAN
99
Status](https://www.r-pkg.org/badges/version/ichimoku?color=00008b)](https://CRAN.R-project.org/package=ichimoku)
10-
[![R-multiverse
11-
status](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fcommunity.r-multiverse.org%2Fapi%2Fpackages%2Fichimoku&query=%24.Version&label=r-multiverse)](https://community.r-multiverse.org/ichimoku)
1210
[![ichimoku status
13-
badge](https://shikokuchuo.r-universe.dev/badges/ichimoku?color=a4d1eb)](https://shikokuchuo.r-universe.dev/ichimoku)
11+
badge](https://shikokuchuo.r-universe.dev/badges/ichimoku)](https://shikokuchuo.r-universe.dev/ichimoku)
1412
[![R-CMD-check](https://github.com/shikokuchuo/ichimoku/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/shikokuchuo/ichimoku/actions/workflows/R-CMD-check.yaml)
1513
[![codecov](https://codecov.io/gh/shikokuchuo/ichimoku/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/ichimoku)
1614
[![DOI](https://zenodo.org/badge/367928545.svg)](https://zenodo.org/badge/latestdoi/367928545)
@@ -31,6 +29,14 @@ Incorporates an interface with the OANDA fxTrade API
3129
streaming price data for major currencies, metals, commodities,
3230
government bonds and stock indices.
3331

32+
## Installation
33+
34+
Install ichimoku from CRAN:
35+
36+
``` r
37+
install.packages("ichimoku")
38+
```
39+
3440
## Quick Start
3541

3642
``` r
@@ -147,20 +153,6 @@ Functions](https://shikokuchuo.net/ichimoku/articles/utilities.html)
147153
{ 4 } [The OANDA fxTrade
148154
API](https://shikokuchuo.net/ichimoku/articles/xoanda.html)
149155

150-
## Installation
151-
152-
Install the latest release from CRAN or R-multiverse:
153-
154-
``` r
155-
install.packages("ichimoku")
156-
```
157-
158-
The current development version is available from R-universe:
159-
160-
``` r
161-
install.packages("ichimoku", repos = "https://shikokuchuo.r-universe.dev")
162-
```
163-
164156
## References
165157

166158
Sasaki, H. 佐々木 英信 (1996), *一目均衡表の研究 [ichimoku kinkouhyou

man/figures/README-ichimoku-1.png

3.4 KB
Loading

0 commit comments

Comments
 (0)