Skip to content

Commit 1b4cae9

Browse files
committed
docs: add simplified Chinese version readme
1 parent 0e2267a commit 1b4cae9

File tree

4 files changed

+62
-3
lines changed

4 files changed

+62
-3
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
^\.vscode$
77
^LICENSE$
88
^\.github$
9+
^docs

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ vignettes/*.pdf
4040
.Renviron
4141

4242
# pkgdown site
43-
docs/
43+
# docs/
4444

4545
# translation temp files
4646
po/*~

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[English](README.md) | [中文](./docs/README.zh.md)
2+
13
# GWalkR: Your One-Stop R Package for Exploratory Data Analysis with Visualization
24

35
![](https://img.shields.io/github/actions/workflow/status/kanaries/GWalkR/web-app-build.yml?style=flat-square)
@@ -12,22 +14,23 @@ It can can simplify your R data analysis and data visualization workflow, by tur
1214

1315
<img width="1437" alt="image" src="https://github.com/Bruceshark/GWalkR/assets/33870780/26967dda-57c0-4abd-823c-63037c8f5168">
1416

17+
> If you prefer using Python, you can check out [PyGWalker](https://github.com/Kanaries/pygwalker)!
1518
1619
## Getting Started
1720

1821
### Setup GWalkR
1922

2023
#### Through Package Archive File (.tar.gz)
2124

22-
First, download the package archive file `GWalkR_0.1.0.tar.gz` from the Github release.
25+
First, download the package archive file `GWalkR_0.1.0.tar.gz` from [this link](https://kanaries-app.s3.ap-northeast-1.amazonaws.com/oss/gwakr/GWalkR_0.1.0.tar.gz).
2326
Open R Studio, click "Install" in the "Packages" window, and select "Package Archive File (.tgz; .tar.gz)" in the "Install from". Then, select the archive in your file system and click "Install".
2427

2528
#### Through Running R Script
2629

2730
Alternatively, you can run the following R code in your script to download without a lot of clicking.
2831

2932
```R
30-
url <- "https://github.com/Bruceshark/GWalkR/releases/download/preview/GWalkR_0.1.0.tar.gz"
33+
url <- "https://kanaries-app.s3.ap-northeast-1.amazonaws.com/oss/gwakr/GWalkR_0.1.0.tar.gz"
3134
destfile <- "GWalkR_0.1.0.tar.gz"
3235
download.file(url, destfile)
3336
install.packages(destfile, repos = NULL, type = "source")
@@ -46,3 +49,5 @@ data(iris)
4649
gwalkr(iris)
4750
```
4851

52+
<img width="1437" alt="image" src="https://github.com/Bruceshark/GWalkR/assets/33870780/718d8ff6-4ad5-492d-9afb-c4ed67573f51">
53+

docs/README.zh.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# GWalkR: 一行代码将数据集转化为交互式可视化分析工具
2+
3+
![](https://img.shields.io/github/actions/workflow/status/kanaries/GWalkR/web-app-build.yml?style=flat-square)
4+
![](https://img.shields.io/github/license/kanaries/GWalkR?style=flat-square)
5+
[![](https://img.shields.io/badge/twitter-kanaries_data-03A9F4?style=flat-square&logo=twitter)](https://twitter.com/kanaries_data)
6+
[![](https://img.shields.io/discord/987366424634884096?color=%237289da&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/WWHraZ8SeV)
7+
8+
一行代码,开启您在R中的数据探索之旅!
9+
10+
[GWalkR](https://github.com/Kanaries/GWalkR) 是R中的交互式探索性数据分析(EDA)工具。
11+
它整合了htmlwidgets和 [Graphic Walker](https://github.com/Kanaries/graphic-walker)
12+
通过将您的数据框转换为Tableau风格的用户界面进行可视化探索,它可以简化您的R数据分析和数据可视化工作流程。
13+
14+
15+
<img width="1437" alt="image" src="https://github.com/Bruceshark/GWalkR/assets/33870780/26967dda-57c0-4abd-823c-63037c8f5168">
16+
17+
> 如果你喜欢使用Python,你可以在Python中使用[PyGWalker](https://github.com/Kanaries/pygwalker)
18+
19+
## 快速开始
20+
21+
### 安装 GWalkR
22+
23+
#### 通过下载 .tar.gz 文件包安装
24+
25+
首先,从[这个链接](https://kanaries-app.s3.ap-northeast-1.amazonaws.com/oss/gwakr/GWalkR_0.1.0.tar.gz)中下载包 GWalkR_0.1.0.tar.gz。
26+
打开 R Studio,点击 "Packages" 窗口中的 "Install",然后在 "Install from" 中选择 "Package Archive File (.tgz; .tar.gz)"。然后,选择您的文件系统中的下载好的包,最后点击"Install"。
27+
28+
#### 通过运行R脚本安装
29+
30+
或者,您可以在脚本中运行以下R代码来下载。
31+
32+
```R
33+
url <- "https://kanaries-app.s3.ap-northeast-1.amazonaws.com/oss/gwakr/GWalkR_0.1.0.tar.gz"
34+
destfile <- "GWalkR_0.1.0.tar.gz"
35+
download.file(url, destfile)
36+
install.packages(destfile, repos = NULL, type = "source")
37+
```
38+
39+
#### 通过 CRAN 安装
40+
41+
即将支持。敬请期待!
42+
43+
44+
### 用一行代码开始您的数据探索吧
45+
46+
```R
47+
library(GWalkR)
48+
data(iris)
49+
gwalkr(iris)
50+
```
51+
52+
<img width="1437" alt="image" src="https://github.com/Bruceshark/GWalkR/assets/33870780/718d8ff6-4ad5-492d-9afb-c4ed67573f51">
53+

0 commit comments

Comments
 (0)