Skip to content

Commit 2d81956

Browse files
committed
update docs
1 parent a4b2362 commit 2d81956

File tree

13 files changed

+136
-65
lines changed

13 files changed

+136
-65
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In recent years, with the development of various cloud computing platforms (such
1515

1616
![Galaxy Platform](https://s1.ax1x.com/2020/07/08/UEk8mV.png)
1717

18-
Hiplot (https://hiplot.org) is a free and comprehensive web service for biomedical visualization based on web technology, which is supported by open source communities. It provides more simple web and command-line interfaces compared with other similar platforms.
18+
Hiplot (ORG) (https://hiplot.org) is a free and comprehensive web service for biomedical visualization based on web technology, which is supported by open source communities. It provides more simple web and command-line interfaces compared with other similar platforms.
1919

2020
Editable table view and switched file uploader simplify the data loading process for most tasks. Data, parameters, and task history can be imported and exported via the JSON files for enhancing reproducibility. A single R language script or function can be used to generate the web front-end interface, command-line interface, and the meta description of a Hiplot plugin. Up to now, hundreds of free applications have been working on Hiplot, including basic statistics, predictive models, multi-omics data analysis, and text-mining.
2121

contribute.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How to contribute
22

3-
You can join the user community first: [Discord](https://discord.gg/vX6tSax) or [Wechat Group](https://docs.qq.com/doc/DS09na3NVYk9OcHVp).
3+
You can join the user community first: [Discord](https://discord.gg/vX6tSax) or [QQ Group](https://docs.qq.com/doc/DS1RJcVZXbHZQT2lV).
44

55
All feedback and visualization scripts can be shared on the user community. We will respond instantly and update the corresponding visualization plugin . For the security of our website, we will do not share the web service code publicly, and only the core team can access and modified it. If you want to join our core team, you can also feel free to contact us: [email protected].
66

download/README.Rmd

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ knitr::opts_chunk$set(echo = TRUE)
66

77
## Desktop Client
88

9-
We build the desktop client of Hiplot based on the [Electron](https://www.electronjs.org/). The demo data and UI components are fixed in the desktop client under the given version.
9+
We build the desktop client of Hiplot (ORG) based on the [Electron](https://www.electronjs.org/). The demo data and UI components are fixed in the desktop client under the given version.
1010

1111
Latest release version:
1212

@@ -19,7 +19,7 @@ Other releases of desktop client: [here](https://hiplot-academic.com/download/de
1919

2020
## hctl
2121

22-
hctl is the command-line client of Hiplot website. It can be used to draw plots without the web environment.
22+
hctl is the command-line client of Hiplot (ORG) website. It can be used to draw plots without the web environment.
2323

2424
Latest release version (v0.1.5):
2525

@@ -29,7 +29,7 @@ download_table("hctl", "versionTerminal")
2929

3030
Other releases of hctl: [here](https://hiplot-academic.com/download/hctl)
3131

32-
It is required to login Hiplot server first using the `hctl login` command. `hctl plot` command can be used to draw plots by using the parameter file and data files.
32+
It is required to login Hiplot (ORG) server first using the `hctl login` command. `hctl plot` command can be used to draw plots by using the parameter file and data files.
3333

3434
Demo input files of hctl can be download from here: [demo.tar.gz](https://hiplot-academic.com/download/hctl/_demo.tar.gz).
3535

download/README.md

+28-27
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,44 @@
44

55
## Desktop Client
66

7-
We build the desktop client of Hiplot based on the [Electron](https://www.electronjs.org/). The demo data and UI components are fixed in the desktop client under the given version.
7+
We build the desktop client of Hiplot (ORG) based on the [Electron](https://www.electronjs.org/). The demo data and UI components are fixed in the desktop client under the given version.
88

99
Latest release version:
1010

1111

12-
|File |Size |Date |MD5 |
13-
|:----------------------------------------------------------------------------------------------------------------------------------|:--------|:----------|:--------------------------------|
14-
|[Hiplot_Desktop_0.2.0_Darwin.dmg](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Darwin.dmg) |85.5 Mb |2022-04-23 |3b9b172ad7c42f21cc5cad7193d3e6fa |
15-
|[Hiplot_Desktop_0.2.0_Linux_amd64.deb](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_amd64.deb) |59.8 Mb |2022-04-23 |1364a9cdda29899cdf7559b21c795839 |
16-
|[Hiplot_Desktop_0.2.0_Linux_x64.apk](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_x64.apk) |87.2 Mb |2022-04-23 |1da132999464e6d8cec6d5bf28f33912 |
17-
|[Hiplot_Desktop_0.2.0_Linux_x86_64.rpm](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_x86_64.rpm) |59.9 Mb |2022-04-23 |1cbaf4cbe039a68cf3c6abeeabacf861 |
18-
|[Hiplot_Desktop_0.2.0_Windows.exe](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows.exe) |127.7 Mb |2022-04-23 |e3209b49148a2107ef4cc5f28de48558 |
19-
|[Hiplot_Desktop_0.2.0_Windows_ia32.exe](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows_ia32.exe) |62.7 Mb |2022-04-23 |bc70b084a6e7357ba2514b053c74ffc8 |
20-
|[Hiplot_Desktop_0.2.0_Windows_x64.exe](https://hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows_x64.exe) |65.8 Mb |2022-04-23 |9e52e69fe0089ac2d9f411a91e29c0ac |
12+
|File |Size |Date |MD5 |
13+
|:-------------------------------------|:--------|:----------|:--------------------------------|
14+
|[Hiplot_Desktop_0.2.0_Darwin.dmg](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Darwin.dmg)|85.5 Mb |2022-04-23 |3b9b172ad7c42f21cc5cad7193d3e6fa |
15+
|[Hiplot_Desktop_0.2.0_Linux_amd64.deb](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_amd64.deb)|59.8 Mb |2022-04-23 |1364a9cdda29899cdf7559b21c795839 |
16+
|[Hiplot_Desktop_0.2.0_Linux_x64.apk](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_x64.apk)|87.2 Mb |2022-04-23 |1da132999464e6d8cec6d5bf28f33912 |
17+
|[Hiplot_Desktop_0.2.0_Linux_x86_64.rpm](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Linux_x86_64.rpm)|59.9 Mb |2022-04-23 |1cbaf4cbe039a68cf3c6abeeabacf861 |
18+
|[Hiplot_Desktop_0.2.0_Windows.exe](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows.exe)|127.7 Mb |2022-04-23 |e3209b49148a2107ef4cc5f28de48558 |
19+
|[Hiplot_Desktop_0.2.0_Windows_ia32.exe](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows_ia32.exe)|62.7 Mb |2022-04-23 |bc70b084a6e7357ba2514b053c74ffc8 |
20+
|[Hiplot_Desktop_0.2.0_Windows_x64.exe](https://download.hiplot-academic.com/download/desktop/v0.2.0/Hiplot_Desktop_0.2.0_Windows_x64.exe)|65.8 Mb |2022-04-23 |9e52e69fe0089ac2d9f411a91e29c0ac |
2121

2222
Other releases of desktop client: [here](https://hiplot-academic.com/download/desktop)
2323

2424
## hctl
2525

26-
hctl is the command-line client of Hiplot website. It can be used to draw plots without the web environment.
26+
hctl is the command-line client of Hiplot (ORG) website. It can be used to draw plots without the web environment.
2727

2828
Latest release version (v0.1.5):
2929

3030

31-
|File |Size |Date |MD5 |
32-
|:---------------------------------------------------------------------------------------------------------------------|:------|:----------|:--------------------------------|
33-
|[hctl_0.1.5_Darwin_64-bit.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Darwin_64-bit.tar.gz) |2.9 Mb |2022-05-07 |06e508f245df311b8be3ce21b9564d4d |
34-
|[hctl_0.1.5_Darwin_arm64.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Darwin_arm64.tar.gz) |2.8 Mb |2022-05-07 |7893e2297ee218bf669a370a9603fc83 |
35-
|[hctl_0.1.5_Linux_32-bit.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Linux_32-bit.tar.gz) |2.7 Mb |2022-05-07 |b00ce96fc48b520a54b575e191f8e87d |
36-
|[hctl_0.1.5_Linux_64-bit.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Linux_64-bit.tar.gz) |2.8 Mb |2022-05-07 |df3fd2c39fd3a00c4789215186cfeadf |
37-
|[hctl_0.1.5_Linux_arm64.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Linux_arm64.tar.gz) |2.6 Mb |2022-05-07 |b922d76e018c986ff32b88e0a54285d5 |
38-
|[hctl_0.1.5_Windows_32-bit.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Windows_32-bit.tar.gz) |2.8 Mb |2022-05-07 |87fe133b83672f2bf2d259eec202ff62 |
39-
|[hctl_0.1.5_Windows_64-bit.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Windows_64-bit.tar.gz) |2.9 Mb |2022-05-07 |61a91a88210d8891f7979cc951df46a7 |
40-
|[hctl_0.1.5_Windows_arm64.tar.gz](https://hiplot-academic.com/download/hctl/v0.1.5/hctl_0.1.5_Windows_arm64.tar.gz) |2.6 Mb |2022-05-07 |06914e83b9245653788f7687d82e0ee8 |
31+
|File |Size |Date |MD5 |
32+
|:--------------------------------|:------|:----------|:--------------------------------|
33+
|[hctl_0.1.6_Darwin_64-bit.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Darwin_64-bit.tar.gz)|2.9 Mb |2022-07-08 |f190fda73ba0b2d1a082a26ae5baccfe |
34+
|[hctl_0.1.6_Darwin_arm64.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Darwin_arm64.tar.gz)|2.8 Mb |2022-07-08 |226be6d982ec451e3781e9685212b521 |
35+
|[hctl_0.1.6_Linux_32-bit.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Linux_32-bit.tar.gz)|2.7 Mb |2022-07-08 |5013c6d3d61a68e344030566d739ce80 |
36+
|[hctl_0.1.6_Linux_64-bit.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Linux_64-bit.tar.gz)|2.8 Mb |2022-07-08 |95b25d72d3a56f0862e48e3980d806a7 |
37+
|[hctl_0.1.6_Linux_arm64.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Linux_arm64.tar.gz)|2.6 Mb |2022-07-08 |045ad19e47e739a90e1593adddddb3ec |
38+
|[hctl_0.1.6_Windows_32-bit.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Windows_32-bit.tar.gz)|2.8 Mb |2022-07-08 |ce57b9c644eeb42f1ec87ad1692e27f7 |
39+
|[hctl_0.1.6_Windows_64-bit.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Windows_64-bit.tar.gz)|2.9 Mb |2022-07-08 |3a5606606a431191ff503102c831f63f |
40+
|[hctl_0.1.6_Windows_arm64.tar.gz](https://download.hiplot-academic.com/download/hctl/v0.1.6/hctl_0.1.6_Windows_arm64.tar.gz)|2.6 Mb |2022-07-08 |2a2a6a0d33b6c251e6a1c9a8ea44780a |
4141

4242
Other releases of hctl: [here](https://hiplot-academic.com/download/hctl)
4343

44-
It is required to login Hiplot server first using the `hctl login` command. `hctl plot` command can be used to draw plots by using the parameter file and data files.
44+
It is required to login Hiplot (ORG) server first using the `hctl login` command. `hctl plot` command can be used to draw plots by using the parameter file and data files.
4545

4646
Demo input files of hctl can be download from here: [demo.tar.gz](https://hiplot-academic.com/download/hctl/_demo.tar.gz).
4747

@@ -89,6 +89,7 @@ hctl plot -p basic-tsne-params.json -o /tmp/hiplot-tsne
8989
## hctl [command]
9090
##
9191
## Available Commands:
92+
## completion Generate the autocompletion script for the specified shell
9293
## config Initializing a config.json file of hiplot application.
9394
## help Help about any command
9495
## login Login Hiplot Website.
@@ -100,7 +101,7 @@ hctl plot -p basic-tsne-params.json -o /tmp/hiplot-tsne
100101
## -o, --out-dir string output dir. (default "/tmp")
101102
## --proxy string HTTP proxy to query.
102103
## --save-log Save log to file.
103-
## -k, --taskname string task ID (default is random). (default "03eba315-0526-4c46-9be3-9bacba3cffcf")
104+
## -k, --taskname string task ID (default is random). (default "edd6b856-654b-4598-a22c-8689fa0b7cf9")
104105
## --timeout int set the timeout of per request. (default 35)
105106
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
106107
## -v, --version version for hctl
@@ -128,26 +129,26 @@ hctl plot -p basic-tsne-params.json -o /tmp/hiplot-tsne
128129
## hctl config basic/pca
129130
## hctl plot -p basic-pca-params.json --load-example true -o /tmp/pca1
130131
## hctl plot -p basic-pca-params.json --load-example 2 -o /tmp/pca2
131-
## hctl plot -p _demo/tsne/basic-tsne-params.json -o /tmp/hiplot-tsne
132+
## hctl plot -p _demo/tsne/basic-tsne-params.json -o /tmp/hiplot-tsne --load-example true
132133
##
133134
## Flags:
134135
## --check-task check task status, taskname and tmpcode are required.
135136
## -c, --config string json format tool config file.
136137
## -d, --data string data table file (sepreate by comma).
137138
## -h, --help help for plot
138-
## --load-example string load example field (only work for hctl config export) (default "true")
139+
## --load-example string load example field (only work for hctl config export) (default "false")
139140
## -m, --module string module name: basic, advance. (default "basic")
140141
## -p, --params string json format tool params file (exported by Hiplot).
141142
## --print-links print result links
142-
## --temp-code string task tempcode. (default "5u3UtXL")
143+
## --temp-code string task tempcode. (default "Lwizf5M")
143144
## -t, --tool string tool name (e.g. heatmap).
144145
##
145146
## Global Flags:
146147
## --log-dir string log dir. (default "/tmp/_log")
147148
## -o, --out-dir string output dir. (default "/tmp")
148149
## --proxy string HTTP proxy to query.
149150
## --save-log Save log to file.
150-
## -k, --taskname string task ID (default is random). (default "63cd0616-c479-4d13-89d7-8a4eafa132d7")
151+
## -k, --taskname string task ID (default is random). (default "d56e2c68-e187-4ee3-b429-5c0a78a1c0f1")
151152
## --timeout int set the timeout of per request. (default 35)
152153
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
153154
```

scripts/download_table.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ download_table <- function (x, version_field) {
88
dest <- file.path(download_dir, x, paste0("v", latest))
99
md5sum <- fread(cmd = sprintf("cat %s/md5sum | sed 's; ;\t;'", dest),
1010
sep = "\t", data.table = FALSE, header = FALSE)
11-
base_dir <- sprintf("https://hiplot-academic.com/download/%s/v%s", x, latest)
11+
base_dir <- sprintf("https://download.hiplot-academic.com/download/%s/v%s", x, latest)
1212
finfo <- file.info(file.path(dest, md5sum[,2]))
1313
md5sum[,"Date"] <- as.Date(finfo$mtime, "%d%b%Y")
1414
md5sum[,"Size"] <- sapply(finfo$size, function(x) {

usage/basic/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,11 @@ Bump chart can be used to display the change of grouped values.
628628

629629
Stack:
630630

631-
## [Diverging scale](/basic/diverging-scale)
631+
## [Diffusion Map](/basic/diffusion-map)
632+
633+
- Introduction
634+
635+
Diffusion Map is a nonlinear dimensionality reduction algorithm that can be used to visualize developmental trajectories.## [Diverging scale](/basic/diverging-scale)
632636

633637
- Introduction
634638

@@ -1619,6 +1623,16 @@ Detail introduction about [PCAtools](http://www.bioconductor.org/packages/releas
16191623

16201624
sort:No means the central axis is arranged in the order of age;Desc means descending order by total population;Asc stands for ascending order by total population.
16211625

1626+
## [Pyramid Stack2](/basic/pyramid-stack2)
1627+
1628+
- Introduction
1629+
1630+
The pyramid stack is a pyramid-like figure that distributes data on both sides of a central axis.
1631+
## [Pyramid Stack](/basic/pyramid-stack)
1632+
1633+
- Introduction
1634+
1635+
The pyramid stack is a pyramid-like figure that distributes data on both sides of a central axis.
16221636
## [QQplot](/basic/qqplot)
16231637

16241638
- Introduction

usage/clinical-tools/README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
# Clinial Tools
22

3-
## [GEP-defind AML subtypes](/clinical-tools/clinaml-gep)
3+
## [AML-G1-G8](/clinical-tools/clinaml-gep2)
4+
5+
- Introduction
6+
7+
Predictiton of the GEP-defined AML subtypes.
8+
9+
G1: PML::RARA
10+
11+
G2: CBFB::MYH11
12+
13+
G3: RUNX1::RUNXT1
14+
15+
G4: biCEBPA/-like
16+
17+
G5: myelodysplasia-related/-like
18+
19+
G6: HOX-committed
20+
21+
G7: HOX-primitive
22+
23+
G8: HOX-mixed## [AML-G1-G6](/clinical-tools/clinaml-gep)
424

525
- Introduction
626

zh/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
![Galaxy Platform](https://s1.ax1x.com/2020/07/08/UEk8mV.png)
2222

23-
Hiplot 是由 openbiox 社区于 2019 年 10 月发起,并在新冠疫情爆发后快速发展的一个社区开发项目:致力于建立一个快速迭代、支持中英文环境的科研数据可视化平台和协作社区。
23+
Hiplot (ORG) 是由 openbiox 社区于 2019 年 10 月发起,并在新冠疫情爆发后快速发展的一个社区开发项目:致力于建立一个快速迭代、支持中英文环境的科研数据可视化平台和协作社区。
2424

2525
目前该平台建设已初具规模,已提供 40 余种基于 R 语言的基础可视化的功能:
2626

zh/download/README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ source("../../scripts/download_table.R")
1515
download_table("desktop", "versionDesktop")
1616
```
1717

18-
其他桌面版本: [这里](https://hiplot-academic.com/download/desktop/)
18+
其他桌面版本: [这里](https://download.hiplot-academic.com/download/desktop/)
1919

2020
## hctl
2121

0 commit comments

Comments
 (0)