You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a [Play Framework](https://www.playframework.com/) version 2.2.4 application. To run the server execute
4
-
```
5
-
play run
6
-
```
7
-
from the project directory. A local server could be accessed at `localhost:9000`.
3
+
VDJviz is a web-based graphical user interface application that allows browsing and analyzing immune repertoire sequencing ([RepSeq](http://onlinelibrary.wiley.com/doi/10.1111/j.1365-2567.2011.03527.x/epdf)) data. It can be used to visualize results of [MITCR](mitcr.milaboratory.com), [MIGEC](https://github.com/mikessh/migec), [MIXCR](mixcr.milaboratory.com) and [MIGMAP](https://github.com/mikessh/migmap) RepSeq processing software as well as popular [IMGT/HighV-QUEST](http://www.imgt.org/HighV-QUEST/login.action) and [ImmunoSEQ Analyzer](http://www.adaptivebiotech.com/immunoseq/analyzer) services. VDJviz can be installed and used as a local server, alternatively you can use an online demo version available at [vdjviz.milaboratory.com](http://vdjviz.milaboratory.com) which currently has an upload limit of 25 datasets each having size at most 10,000 clonotypes. The list of VDJviz features at a glance:
8
4
9
-
This application uses [VDJtools](https://github.com/mikessh/vdjtools) API to compute various immune repertoire statistics and [D3.js](http://d3js.org/) library for interactive graphs.
5
+
- Clonotype table browsing with V/D/J markup.
6
+
- CDR3 pattern matching for a single sample and across multiple samples with flexible filters.
7
+
- Spectratype, V-Spectratype, V-J usage and clonality analysis. Those can be compared side-by-side using the Compare panel.
8
+
- Summary statistics and rarefaction for multiple samples.
9
+
- Clonotype sharing across samples (many-to-many intersection) with flexible clonotype matching criteria.
10
+
- Uploaded data sharing.
11
+
12
+
VDJviz uses [VDJtools API](https://github.com/mikessh/vdjtools) as a back-end. The software utilizes [Play framework](https://www.playframework.com/) for running the server instance and state-of-art web graphics libraries such as [D3js](http://d3js.org/) for visualization.
13
+
14
+
## Installation
15
+
16
+
The most straightforward way to install VDJviz as a local server is to download the [latest release package](https://github.com/antigenomics/vdjviz/releases/latest).
17
+
18
+
After downloading unzip the package wherever you want, but please avoid long paths and spaces (Windows version is especially sensitive to it).
19
+
20
+
You can find the server executable in ``bin/`` directory. To set up the server:
21
+
22
+
- Run `vdjviz.bat` file (Windows)
23
+
- Run `bash vdjviz -Dconfig.file=application.conf` in your console (Linux/Mac OS)
24
+
25
+
Wait until the server is started, and go to ``localhost:9000`` URL in your browser to open VDJviz.
26
+
The user generator is enabled in the config by default, so you can login with `vdjviz1@vdjviz.com` as an email and `vdjviz1` as password,
27
+
28
+
To stop application just press `Ctrl-C` at any time in console.
10
29
11
30
## Server configuration
12
31
13
-
Before using this application you will need to edit `application.conf` and `securesocial.conf` files in the `conf/` directory
32
+
VDJviz server configuration can be performed by manually editing ``application.conf`` file in the ``bin/`` directory. The configuration file has the following fields:
33
+
34
+
-``application.secret``
35
+
The secret key used in cryptographic hash functions.
36
+
37
+
-``uploadPath``
38
+
Specifies the path that will be used by VDJviz to store user's uploaded files.
39
+
You can use '~' symbol as a shortcut for user home directory.
40
+
Default: `~/vdjviz/`
41
+
42
+
-``maxFileSize``
43
+
File size limit in kB
44
+
Default: `0` (no limit)
45
+
46
+
-``maxFilesCount``
47
+
Limit on the number of uploaded files per user.
48
+
Default: ``0`` (no limit)
49
+
50
+
-``maxClonotypesCount``
51
+
Limit on the number of clonotypes for each uploaded file.
52
+
Default: ``0`` (no limit)
53
+
54
+
-``allowSharing``
55
+
Disable or enable sharing feature
56
+
Default: ``true`` (enabled)
57
+
58
+
-``maxSharedGroups``
59
+
Maximum number of shared analyses per user.
60
+
Default: ``0`` (no limit)
61
+
62
+
-``deleteAfter``
63
+
Time period after which uploaded files are deleted from the server, in hours.
64
+
Default: ``0`` (never)
14
65
15
-
*application.conf*
16
-
-`uploadPath`, points to the path that will be used to store user-uploaded files
17
-
-`maxFileSize`, max allowed file size (set it to `0` to remove the limit)
18
-
-`maxFilesCount`, max number of uploaded files per user (set it to `0` to remove the limit)
19
-
-`maxClonotypesCount`, max number of rows in clonotype table (set it to `0` to remove the limit)
20
-
-`deleteAfter`, time after the cache is deleted (disabled if set to `0`)
21
-
-`application.secret`, the secret key used in cryptographic hash functions
22
-
-`db.default.*`, database configuration
23
-
-`smtp.*`, SMTP server configuration
66
+
-``applyNewLimitsToOldUsers``
67
+
If set to ``true`` the server will automatically update limtis of all existing user accounts according to the ones specified in config. If set to ``false``, the limits will only be applied to newly created users.
68
+
Default: ``true``
24
69
25
-
In fact the configuration file is used only when the application is creating user's account. After that server is guided by your account's limits for uploading files. This is done in order to be able to specify different limits for different accounts. So if you change the default configuration it will not affect already created accounts.
70
+
-``createDefaultUsers``
71
+
Specifies whether the server will generate some default user accounts with predefined emails and passwords, setting their emails to ``<nameDefaultUser><id>@vdjviz.com`` (e.g. ``vdjviz1@vdjviz.com``) and passwords to ``<nameDefaultUser><id>`` (e.g. ``vdjviz1``). Set this option to ``false`` if you don't need this feature and prefer to use registration via SMTP.
72
+
Default: ``true``
26
73
27
-
*securesocial.conf*
28
-
-`smtp`, set up the SMTP server to send registration confirmation e-mails
74
+
-``nDefaultUsers``
75
+
Number of default users to be created.
76
+
Default: ``1``
29
77
30
-
## Database configuration
31
-
The application uses [MySQL DBMS](http://www.mysql.com/) for handling metadata by default, if you want to change MySQL to another DBMS please see the [corresponding Play documentation section](https://www.playframework.com/documentation/2.2.4/JavaDatabase)
32
-
-`db.default.user`, MySQL server username
33
-
-`db.default.password`, MySQL server password
34
-
<br>
78
+
-``nameDefaultUser``
79
+
Default user name prefix.
80
+
Default: `vdjviz`
35
81
36
-
After setting your login and password, create **vdjviz** database by typing `CREATE DATABASE vdjviz;` in MySQL console
82
+
-``db.default.url``
83
+
Points to the path that will be used to store H2 database file.
84
+
Default value: ``~/vdjviz/h2.db``
85
+
Standalone version uses [H2 Database](http://www.h2database.com/html/main.html) for handling metadata by default, if you want to change H2 to another DBMS please see the corresponding Play documentation [section](https://www.playframework.com/documentation/2.2.4/JavaDatabase)
86
+
You can also use this database to manually modify user limits.
37
87
38
-
##Dependency
88
+
-``allowRegistration``
89
+
Show the Register button in login screen.
90
+
Default: ``false``
39
91
40
-
-[milib](https://github.com/milaboratory/milib)
41
-
-[vdjtools](https://github.com/mikessh/vdjtools)
92
+
-``allowChangePasswords``
93
+
Show the Change Password button in login screen.
94
+
Default: ``false``
42
95
96
+
-``smtp.*``
97
+
SMTP server configuration.
98
+
If you don't want to use registration features, you can leave ``smtp.*`` fields empty and generate default users.
0 commit comments