Skip to content

Commit ee66e10

Browse files
committed
add qa.md and hisub.md
1 parent 5916e50 commit ee66e10

File tree

25 files changed

+2663
-356
lines changed

25 files changed

+2663
-356
lines changed

.vuepress/config.js

+9-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ module.exports = {
5757
children: [
5858
'/',
5959
'/modules',
60+
'/hisub',
6061
'/env',
6162
'/download/',
63+
'/qa',
6264
'/contribute',
6365
'/about'
6466
]
@@ -67,7 +69,9 @@ module.exports = {
6769
"title": 'Getting Started',
6870
collapsable: true,
6971
children: [
70-
'/usage/basic/'
72+
'/usage/basic/',
73+
'/usage/advance/',
74+
'/usage/mini-tools/'
7175
]
7276
}
7377
],
@@ -99,14 +103,17 @@ module.exports = {
99103
children: [
100104
'/zh/',
101105
'/zh/modules',
106+
'/zh/hisub',
102107
'/zh/download/'
103108
]
104109
},
105110
{
106111
"title": '入门指南',
107112
collapsable: true,
108113
children: [
109-
'/zh/usage/basic/'
114+
'/zh/usage/basic/',
115+
'/zh/usage/advance/',
116+
'/zh/usage/mini-tools/'
110117
]
111118
},
112119
{

README.md

+4-60
Original file line numberDiff line numberDiff line change
@@ -4,75 +4,19 @@
44

55
[English Version](./) | [中文版](./zh)
66

7-
Visualization of data is required for most scientific research. Based on visual graphics, we can better display the major features of scientific data. The clinical medical students and junior researchers frequently need to spend dozens of days or even months to learn visualization tools, such as SPSS, Origin, and Graphpad. If you want to specialize in data analysis and modeling, you need to learn one or more programming languages ​​(such as MATLAB, R, and Python). To reach the level where you can freely explore data, you need to spend more time on in-depth learning and advanced.
7+
Interactive visualization and personalized in-depth interpretation of multi-dimensional scientific research data have become one of the major challenges for quantitative researches.
88

99
In recent years, with the development of various cloud computing platforms (such as Galaxy and DNAnexus in the biomedical field) and IT hardware and software (such as distributed computing, container technology, package manager, workflow language, etc.), junior researchers can easily obtain the upstream result. Moreover, when the upstream analysis process of conventional omics data tends to be stable and perfect, the customization and variability of the upstream analysis process have been greatly reduced. The visualization and personalized in-depth interpretation in the downstream process of data analysis have become the biggest challenge facing current users:
1010

1111
1. Most of the visualization software or methods developed by the open source user community have not been well integrated under a unified user interface;
1212
2. There is no active collaborative community for the visualization of scientific research data in China, and the "** Draw Group" has become one of the few choices for primary scientific research users;
1313
3. There is a lack of core data visualization software and platforms similar to Graphpad and MATLAB in China. After being banned by the United States, they can only spend additional costs to migrate the process or start over;
14-
4. There are several disadvantages of existing platforms and tools: the user interface is not beautiful enough; lack of the Chinese and English support; it is still difficult to get started; the file Manager of some platforms is not convenient; users cannot actively participate in platform development;
15-
5. Data visualization tools are still relatively scarce.
14+
4. There are several disadvantages of existing platforms and tools: the user interface is not beautiful enough; lack of the Chinese and English support; it is still difficult to get started; the file Manager of some platforms is not convenient; users cannot actively participate in platform development.
1615

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

19-
[Hiplot](https://hiplot.com.cn) is one of the community-driven bioinformatics data visualization platforms. This project started in October 2019 and accelerate in 2020 after COVID-19 breakout. It consists of a 6-person core team covering the IT, bioinformatics students, statistical analysts, and clinicians. The interdisciplinary cooperation may help us for better development of this application.
20-
The major development goals of Hiplot:
21-
- Provide the simple and easy-to-use Web and RESTful APIs for the bioinformatics data visualization tools that are no graphical interface support yet.
22-
- Features cover the basic statistics and visualization, predictable clinical models, data analysis of macrobiotics, and the bioinformatics applications of deep learning methods
23-
- Building a collaborative bioinformatics community for the data visualization
18+
Hiplot (https://hiplot.com.cn) is a free and comprehensive cloud platform for scientific computation and 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.
2419

25-
Untill now, we have been developed more than 40 visualization plugins on the Hiplot platform and are still increasing:
26-
27-
![](https://pic3.zhimg.com/80/v2-9ec5275aff039798cf35ba73e109de38_720w.jpg)
28-
29-
**User Interface Examples:**
30-
31-
![](https://picb.zhimg.com/80/v2-fe6589d314076c4ed185d52bfb86eba3_720w.jpg)
32-
33-
Login
34-
35-
![](https://pic4.zhimg.com/80/v2-99efc0528963311e562a49eb828822c4_720w.jpg)
36-
37-
Signup
38-
39-
![](https://pic1.zhimg.com/80/v2-92ec8062a7548e83ead15e8fc15f27ab_720w.jpg)
40-
41-
Overview of basic plots
42-
43-
![](https://pic3.zhimg.com/80/v2-269dac241079408cd78b68a36b38ae41_720w.jpg)
44-
45-
Demo | Correlation heatmap
46-
47-
![](https://pic3.zhimg.com/80/v2-7f775eb457c0ba3c410cbfb23ec9cd17_720w.jpg)
48-
49-
Demo | Immune Infiltration Analysis
50-
51-
![](https://picb.zhimg.com/80/v2-562a022353bc8eac39f4e5f5db4f320e_720w.jpg)
52-
53-
Upload files
54-
55-
![](https://pic1.zhimg.com/80/v2-e22822a6d179aaff5320b478ee0388ba_720w.jpg)
56-
57-
Manager of files
58-
59-
![](https://pic2.zhimg.com/80/v2-24406918e07c06aeae75cb6e704b6eeb_720w.jpg)
60-
61-
Online view and edit files
62-
63-
![](https://pic3.zhimg.com/80/v2-efcf77da5d64ecff6deac844bd3abb46_720w.jpg)
64-
65-
Online view and edit files
66-
67-
![](https://pic3.zhimg.com/80/v2-c2566db9ed1c631ac73a84459a2b2d56_720w.jpg)
68-
69-
Download publications and supplementary data based on [bget](https://github.com/openanno/bget)
70-
71-
![](https://picb.zhimg.com/80/v2-af4a1fa4bf3913c1cebe2c1dcb2dea2a_720w.jpg)
72-
73-
Download publications and supplementary data based on [bget](https://github.com/openanno/bget)
74-
75-
If you want to contribute the Hiplot project, you can fell free to join our community: [Discord](https://discord.gg/vX6tSax).
20+
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.
7621

7722
This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
78-

about.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# About Us
22

3-
Hiplot Team members mainly come from the [openbiox](https://github.com/openbiox) communitiy.
3+
Hiplot team members mainly come from the [openbiox](https://github.com/openbiox) communitiy.

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).
3+
You can join the user community first: [Discord](https://discord.gg/vX6tSax) or [Wechat Group](https://docs.qq.com/doc/DS09na3NVYk9OcHVp).
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

+28-8
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,45 @@
33
```{r setup, include=FALSE}
44
knitr::opts_chunk$set(echo = TRUE)
55
```
6+
7+
## Desktop Client
8+
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.
10+
11+
Latest release version (v0.1.0):
12+
13+
**Linux:**
14+
15+
- [Hiplot_Desktop_0.1.0_Linux_x86_64.AppImage](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Linux_x86_64.AppImage)
16+
- [Hiplot_Desktop_0.1.0_Linux_amd64.snap](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Linux_amd64.snap)
17+
18+
**Windows:**
19+
20+
- [Hiplot_Desktop_0.1.0_Windows.exe](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Windows.exe)
21+
22+
**MAC OSX**
23+
24+
- [Hiplot_Desktop_0.1.0_Darwin.dmg](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Darwin.dmg)
25+
626
## hctl
727

828
hctl is the command-line client of Hiplot website. It can be used to draw plots without the web environment.
929

10-
Latest release version (v0.1.2):
30+
Latest release version (v0.1.3):
1131

1232
**Linux:**
1333

14-
- [hctl_0.1.2_Linux_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_64-bit.tar.gz)
15-
- [hctl_0.1.2_Linux_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_32-bit.tar.gz)
34+
- [hctl_0.1.3_Linux_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_64-bit.tar.gz)
35+
- [hctl_0.1.3_Linux_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_32-bit.tar.gz)
1636

1737
**MAC OSX:**
1838

19-
- [hctl_0.1.2_Darwin_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Darwin_64-bit.tar.gz)
39+
- [hctl_0.1.3_Darwin_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Darwin_64-bit.tar.gz)
2040

2141

2242
**Windows:**
23-
- [hctl_0.1.2_Windows_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Windows_64-bit.tar.gz)
24-
- [hctl_0.1.2_Windows_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Windows_32-bit.tar.gz)
43+
- [hctl_0.1.3_Windows_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Windows_64-bit.tar.gz)
44+
- [hctl_0.1.3_Windows_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Windows_32-bit.tar.gz)
2545

2646
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.
2747

@@ -31,10 +51,10 @@ Demo input files of hctl can be download from here: [demo.tar.gz](https://hiplot
3151
## Linux 64 Demo
3252
mkdir /tmp/hiplot
3353
cd /tmp/hiplot
34-
wget https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_64-bit.tar.gz
54+
wget https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_64-bit.tar.gz
3555
wget https://hiplot.com.cn/download/hctl/_demo.tar.gz
3656

37-
tar -xzvf hctl_0.1.2_Linux_64-bit.tar.gz
57+
tar -xzvf hctl_0.1.3_Linux_64-bit.tar.gz
3858
tar -xzvf _demo.tar.gz
3959

4060
./hctl login

download/README.md

+49-21
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,45 @@
11
# Download
22

33

4+
5+
## Desktop Client
6+
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.
8+
9+
Latest release version (v0.1.0):
10+
11+
**Linux:**
12+
13+
- [Hiplot_Desktop_0.1.0_Linux_x86_64.AppImage](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Linux_x86_64.AppImage)
14+
- [Hiplot_Desktop_0.1.0_Linux_amd64.snap](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Linux_amd64.snap)
15+
16+
**Windows:**
17+
18+
- [Hiplot_Desktop_0.1.0_Windows.exe](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Windows.exe)
19+
20+
**MAC OSX**
21+
22+
- [Hiplot_Desktop_0.1.0_Darwin.dmg](https://hiplot.com.cn/download/desktop/v0.1.0/Hiplot_Desktop_0.1.0_Darwin.dmg)
23+
424
## hctl
525

626
hctl is the command-line client of Hiplot website. It can be used to draw plots without the web environment.
727

8-
Latest release version (v0.1.2):
28+
Latest release version (v0.1.3):
929

1030
**Linux:**
1131

12-
- [hctl_0.1.2_Linux_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_64-bit.tar.gz)
13-
- [hctl_0.1.2_Linux_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_32-bit.tar.gz)
32+
- [hctl_0.1.3_Linux_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_64-bit.tar.gz)
33+
- [hctl_0.1.3_Linux_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_32-bit.tar.gz)
1434

1535
**MAC OSX:**
1636

17-
- [hctl_0.1.2_Darwin_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Darwin_64-bit.tar.gz)
37+
- [hctl_0.1.3_Darwin_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Darwin_64-bit.tar.gz)
1838

1939

2040
**Windows:**
21-
- [hctl_0.1.2_Windows_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Windows_64-bit.tar.gz)
22-
- [hctl_0.1.2_Windows_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Windows_32-bit.tar.gz)
41+
- [hctl_0.1.3_Windows_64-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Windows_64-bit.tar.gz)
42+
- [hctl_0.1.3_Windows_32-bit.tar.gz](https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Windows_32-bit.tar.gz)
2343

2444
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.
2545

@@ -29,10 +49,10 @@ Demo input files of hctl can be download from here: [demo.tar.gz](https://hiplot
2949
## Linux 64 Demo
3050
mkdir /tmp/hiplot
3151
cd /tmp/hiplot
32-
wget https://hiplot.com.cn/download/hctl/v0.1.2/hctl_0.1.2_Linux_64-bit.tar.gz
52+
wget https://hiplot.com.cn/download/hctl/v0.1.3/hctl_0.1.3_Linux_64-bit.tar.gz
3353
wget https://hiplot.com.cn/download/hctl/_demo.tar.gz
3454

35-
tar -xzvf hctl_0.1.2_Linux_64-bit.tar.gz
55+
tar -xzvf hctl_0.1.3_Linux_64-bit.tar.gz
3656
tar -xzvf _demo.tar.gz
3757

3858
./hctl login
@@ -67,13 +87,15 @@ tar -xzvf _demo.tar.gz
6787
## plot Plot functions of Hiplot Website.
6888
##
6989
## Flags:
70-
## -h, --help help for hctl
71-
## --log-dir string log dir. (default "/tmp/_log")
72-
## -o, --out-dir string output dir. (default "/tmp")
73-
## --save-log Save log to file.
74-
## -k, --task-id string task ID (default is random). (default "4b972a37-e32d-407f-b33b-25616687d282")
75-
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
76-
## -v, --version version for hctl
90+
## -h, --help help for hctl
91+
## --log-dir string log dir. (default "/tmp/_log")
92+
## -o, --out-dir string output dir. (default "/tmp")
93+
## --proxy string HTTP proxy to query.
94+
## --save-log Save log to file.
95+
## -k, --taskname string task ID (default is random). (default "ec33d443-9bd7-4fdd-a4da-871afca59d3d")
96+
## --timeout int set the timeout of per request. (default 35)
97+
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
98+
## -v, --version version for hctl
7799
##
78100
## Use "hctl [command] --help" for more information about a command.
79101
```
@@ -94,22 +116,28 @@ tar -xzvf _demo.tar.gz
94116
## hctl plot -p _demo/heatmap/params.json -t heatmap -o /tmp/hiplot-params-mode
95117
## hctl plot -p _demo/heatmap/params2.json -o /tmp/hiplot-params-mode2
96118
## hctl plot -p _demo/heatmap/basic-heatmap-params.json --load-example true -o /tmp/hiplot-params-mode3
119+
## hctl plot --check-task --temp-code QwbMBp7 --taskname 62919a54-ee68-49c4-b070-7384c60fb05f --tool clusterprofiler-go-kegg -m advance -o /tmp/clusterprofiler-go-kegg
120+
## hctl plot -p basic-pca-params.json --load-example true -o /tmp/pca1
121+
## hctl plot -p basic-pca-params.json --load-example 2 -o /tmp/pca2
97122
##
98123
## Flags:
124+
## --check-task check task status, taskname and tmpcode are required.
99125
## -c, --config string json format tool config file.
100126
## -d, --data string data table file (sepreate by comma).
101127
## -h, --help help for plot
102128
## --load-example string load example field (only work for hctl config export) (default "true")
103129
## -m, --module string module name: basic, advance. (default "basic")
104130
## -p, --params string json format tool params file (exported by Hiplot).
105131
## --print-links print result links
106-
## --temp-code string task tempcode. (default "2aXExDR")
132+
## --temp-code string task tempcode. (default "4NITDXp")
107133
## -t, --tool string tool name (e.g. heatmap).
108134
##
109135
## Global Flags:
110-
## --log-dir string log dir. (default "/tmp/_log")
111-
## -o, --out-dir string output dir. (default "/tmp")
112-
## --save-log Save log to file.
113-
## -k, --task-id string task ID (default is random). (default "63829dbd-13fb-47b8-9cc9-b957d8053287")
114-
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
136+
## --log-dir string log dir. (default "/tmp/_log")
137+
## -o, --out-dir string output dir. (default "/tmp")
138+
## --proxy string HTTP proxy to query.
139+
## --save-log Save log to file.
140+
## -k, --taskname string task ID (default is random). (default "fc37fcfe-a159-46db-8fc8-228b469017d6")
141+
## --timeout int set the timeout of per request. (default 35)
142+
## --verbose int verbose level (0:no output, 1: basic level, 2: with env info) (default 1)
115143
```

env.Rmd

-6
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,6 @@ dat <- BioInstaller::conda.list()
110110
knitr::kable(dat, row.names = F)
111111
```
112112

113-
## Installed Spack packages
114-
115-
```{bash message=FALSE, warning=FALSE, echo=FALSE}
116-
spack find
117-
```
118-
119113
## Sessioninfo
120114

121115
```{r message=FALSE, warning=FALSE, echo=FALSE}

hisub.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Hisub
2+
3+
Content...

0 commit comments

Comments
 (0)