-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
85 lines (61 loc) · 2.77 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
output: github_document
---
# lixingr
<!-- badges: start -->
[](https://github.com/tanchangde/lixingr/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/tanchangde/lixingr?branch=main)
<!-- badges: end -->
An R language wrapper for the lixinger API.
## User Guide
### Prerequisites
Basic knowledge of R is required. If lacking, it is recommended to quickly get started using [this material](https://bookdown.org/wangminjie/R4DS/), estimated to take one or two hours.
### Installation
```r
devtools::install_github('tanchangde/lixingr')
```
### Configuration
- Register and log in to lixinger, then acquire a `Token` from the [Open Platform](https://www.lixinger.com/open/api/token).
- Enter `file.edit("~/.Renviron")` in the R console, then append a new line to the opened file: `TOKEN_LIXINGER = "acquired Token"`, save and close the `.Renviron` file.
## Motivation
- For creating reproducible, reusable, and version-controllable investment research reports.
- To reduce repetitive data copying and pasting.
- To practice API wrapping.
- To accumulate R package works.
## Goals
- [x] Beginner, implement key fundamental indicators for mainland stocks
- [x] PB
- [x] PE
- [x] ROE
- [x] Debt Ratio
- [x] Dividend Payout Ratio
- [x] Intermediate, implement most practical indicators.
- [x] Advanced Intermediate, package into an R package.
- [ ] Advanced, provide interactive analysis services.
## Contributing Code
The commit logs for this project follow this [style guide](https://open.leancloud.cn/git-commit-message/). Please try to adhere to it. The optional scopes are:
- cn-company
- cn-index
- cn-industry
- cn-fund
- hk-company
- hk-index
- hk-industry
- us-index
- macro
## Why Choose lixinger
- [Product, Code and Investment — Product Chapter](https://www.lixinger.com/marketing/about-us-product)
- [Product, Code and Investment — Code Chapter](https://www.lixinger.com/marketing/about-us-coding)
## References
- [knitr and Reproducible Statistical Research](https://cosx.org/2012/06/reproducible-research-with-knitr/)
- [Lixinger Open Platform API Documentation](https://www.lixinger.com/open/api/doc)
- [Package Development :: Cheatsheet](https://rstudio.github.io/cheatsheets/html/package-development.html)
## ChangeLog
- 240101 changde Refactored as an R package
- 221023 changde Added and updated functions, rearranged example code
- 220705 changde Detailed user guide
- 220630 changde Added usage
- 220629 changde
- Adjusted goal priorities
- Added references and refined text
- 220627 changde init