tanchangde / lixingr

An R language wrapper for the lixinger (理杏仁) API.

lixingr

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, estimated to take one or two hours.

Installation

devtools::install_github('tanchangde/lixingr')

Configuration

• Register and log in to lixinger, then acquire a Token from the Open Platform.
• 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

• Beginner, implement key fundamental indicators for mainland stocks
  • PB
  • PE
  • ROE
  • Debt Ratio
  • Dividend Payout Ratio
• Intermediate, implement most practical indicators.
• Advanced Intermediate, package into an R package.
• Advanced, provide interactive analysis services.

Contributing Code

The commit logs for this project follow this style guide. 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
• Product, Code and Investment — Code Chapter

References

• knitr and Reproducible Statistical Research
• Lixinger Open Platform API Documentation
• Package Development :: Cheatsheet

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