Skip to content
This repository was archived by the owner on Apr 10, 2022. It is now read-only.

Commit e5718b1

Browse files
committed
Update doc
1 parent 0653261 commit e5718b1

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ Next modify the `source.R` as your wish and convert it into your Hiplot plugin.
3232
./hisub.R source.R <output-directory>
3333
```
3434

35+
For better use this tools, I recommend you to generate a soft link to the `hisub.R` with command similar to
36+
37+
```sh
38+
ln -s ~/Documents/GitHub/hiplot-plugin-generator/hisub.R ~/.local/bin/hisub
39+
```
40+
41+
Change the first path to your clone `hisub.R` path and change the second path to a path store executable file.
42+
NOTE, the second path should be in system `PATH` variable so you can call **HiSub** with `hisub`.
3543

3644
### Hello World
3745

hisub.R

+9
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ if (length(Args) == 1) {
9494
}
9595
}
9696

97+
if (length(Args) == 0) {
98+
message("No operations detected.")
99+
message("Usage:")
100+
message("\t[hisub template] to generate a template.")
101+
message("\t[hisub source.R ... outdir] to convert R script to Hiplot plugin.")
102+
message("\nDetails see <https://github.com/hiplot/hiplot-plugin-generator>")
103+
quit("no", -1)
104+
}
105+
97106
# 如果传入的不是 2 个参数,中间的文件原样拷贝到插件目录以支持
98107
# 已准备好的数据文件或其他所需脚本
99108
fc <- file_content <- read_lines(Args[1])

0 commit comments

Comments
 (0)