@@ -10,29 +10,48 @@ Gitools is listening to the port **50151** by default. So it is possible to send
1010Overview of commands
1111-------------------------------------------------
1212
13- ================================================ ============================================ ===================================================================================== ======================
14- Command Description Options as of Version
15- ================================================ ============================================ ===================================================================================== ======================
16- **add-header-colored-labels ** Adds a new colored labels header 2.0.0
17- - -c (--color) <color> : A Hex color as '#FF0000' - depends on --value
18- - -h (--heatmap) <heatmap> : Heatmap name or ``last `` for the last added
19- - -n (--no-auto-generate) : Specify if auto color generation is not desired.
20- - -p (--pattern) <pattern> : The pattern of annotations as e.g. ${annotation-id}
21- - -d (--dimension) <dim> : Indicate where to add the header: 'rows' or 'columns'.
22- - -t (--text-visible) : Set for visible text labels
23- - -v (--value) <value> : A value corresponding to a color
13+ ================================================ ============================================ ========================================================================================= ======================
14+ Command Description Options as of Version
15+ ================================================ ============================================ ========================================================================================= ======================
16+ **add-header-colored-labels ** Adds a new colored labels header 2.0.0
17+ - ``-c (--color) <color> `` : A Hex color as '#FF0000' - depends on --value
18+ - ``-n (--no-auto-generate) `` : Specify if auto color generation is not desired.
19+ - ``-p (--pattern) <pattern> `` : The pattern of annotations as e.g. ${annotation-id}
20+ - ``-d (--dimension) <dim> `` : Indicate where to add the header: 'rows' or 'columns'.
21+ - ``-t (--text-visible) `` : Set for visible text labels
22+ - ``-v (--value) <value> `` : A value corresponding to a color
23+ - ``-h (--heatmap) <heatmap> `` : (Optional) Heatmap name or ``last `` for the last added
24+
2425**add-header-text-labels** Adds a new text header to the heatmap
25- - -h (--heatmap) <heatmap> : Heatmap
26- - -p (--pattern) <pattern> : The pattern of annotations as e.g. ${annotation-id} 2.0.0
27- - -d (--dimension) <dim> : Indicate where to add the header: 'rows' or 'columns'.
26+ - ``-p (--pattern) <pattern> `` : The pattern of annotations as e.g. ${annotation-id} 2.0.0
27+ - ``-d (--dimension) <dim> `` : Indicate where to add the header: 'rows' or 'columns'.
28+ - ``-h (--heatmap) <heatmap> `` : Heatmap name. Not compulsory if one is open.
29+ **close ** Closes a heatmap and optionally saves (as)
30+ - ``-a (--as) <FILE_NAME> `` : path and filename indicating where to save the heatmap 2.2.1
31+ - ``-d (--discard-hidden) `` : Discard hidden data
32+ - ``-h (--heatmap) <heatmap> `` : (optional) 'LAST' or heatmap name
33+ - ``-o (--optimize) `` : Optimize data file (slower saving process)
34+ - ``-s (--save) `` : Save current state as heatmap
35+ **help ** Prints all available commands
36+ **load **\ matrix-file Tells Gitools to load a file. - ``--rows** (-r) `` : File rows annotations 1.7.0
37+ - ``--cols (-c) `` : File cols annotations
2838**sort-by-annotation ** Sorts the heatmap by col or row annotation
29- - -h (--heatmap) <heatmap> : Heatmap
30- - -p (--pattern) <pattern> : The pattern of annotations as e.g. ${annotation-id} 2.2.0
31- - -d (--dimension) <dim> : Indicate where to add the header: 'rows' or 'columns'.
32- **load **\ matrix-file Tells Gitools to load a file. - **--rows ** ( **-r **) : File rows annotations 1.7.0
33- - **--cols ** ( **-c **) : File cols annotations
34- **version ** Prints Gitools version. 1.7.1
35- ================================================ ============================================ ===================================================================================== ======================
39+ - ``-p (--pattern) <pattern> `` : The pattern of annotations as e.g. ${annotation-id} 2.2.0
40+ - ``-d (--dimension) <dim> `` : Indicate where to add the header: 'rows' or 'columns'.
41+ - ``-h (--heatmap) <heatmap> `` : Heatmap name. Not compulsory if one is open.
42+ **sort-mutex ** Sorts the visible layer by mutual excl.
43+ - ``-d (--dimension) <dimension> `` : Indicate where to add the header: 'rows' or 2.2.1
44+ 'columns'.
45+ - ``-h (--heatmap) <heatmap> `` : (optional) 'LAST' or heatmap name
46+ - ``-i (--identifier) <identifier> `` : Specify this option for each identifier which
47+ you want to include in the mutex sorting
48+ - ``-p (--pattern) <pattern> `` : The pattern of annotations as e.g.
49+ ${annotation-id}
50+ - ``-s (--sort) <sort> `` : Sort according to header. Specify either
51+ asc[ending] or desc[ending].
52+
53+ **version** Prints Gitools version. 1.7.1
54+ ================================================ ============================================ ========================================================================================= ======================
3655
3756
3857
@@ -71,8 +90,11 @@ internet protocol. See below to understand how python can connect to Gitools and
7190.. code-block :: python
7291
7392 import socket
74- gitools = socket .socket(socket .AF \_INET, socket .SOCK\_STREAM)
75- gitools .connect(( ’localhost’, 50151 ))
76- command = ”load / home/ user/ matrix- file .tdm -- cols / home/ user/ col- annotations.tsv -- rows / home/ user/ row- annotations.tsv”
77- gitools .send( command )
78- gitools .close()
93+ def gitools_command (command ):
94+ gitools = socket.socket(socket.AF_INET , socket.SOCK_STREAM )
95+ gitools.connect((" localhost" , 50151 ))
96+ gitools.sendall( command.encode(' utf-8' ))
97+ gitools.close()
98+
99+ command = " load /home/user/matrix-file.tdm --cols /home/user/col-annotations.tsv --rows /home/user/row-annotations.tsv"
100+ gitools_command(command)
0 commit comments