usage.rst 82.1 KB
Newer Older
1
2
3
Command Line Interface
======================

4
5
6
7
8
9
10
11
12
13
14
15
16
Two CLI:abbr:`Command Line Interface` are accessible after the installation.

    * :command:`aria2`: interface for setting up and running an ARIA project
    * :command:`ariaec` [1]_: interface for converting and analyze contact maps

ARIA2
-----

Please refer to the `ARIA documentation <http://aria.pasteur.fr/>`_ for more
explanations.

ARIAEC
------
17

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
18
.. code-block:: shell
19

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
20
    ariaec [-h] -o OUTPUT_DIRECTORY [-c CONF_FILE] [--nolog] [-d] COMMAND
21
22
23
24
25
26
27
28
29


**Commands**

.. rst-class:: table-hover


+-------------------------+-----------------------------------------------------+
|  Name                   | Short description                                   |
30
+=========================+=====================================================+
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
| `setup <Setup_>`_       | Setup ARIA project with EC data                     |
+-------------------------+-----------------------------------------------------+
| `bbconv <BBconv_>`_     | Translate BBcontacts as distance restraints         |
+-------------------------+-----------------------------------------------------+
| `maplot <Maplot_>`_     | Contact map visualisation tool                      |
+-------------------------+-----------------------------------------------------+
| `pdbqual <PDBQual_>`_   | Call PDB quality tools                              |
+-------------------------+-----------------------------------------------------+
| `analysis <Analysis_>`_ | Analyze results from an ARIA project                |
+-------------------------+-----------------------------------------------------+
| `tbl2xml <TBL2XML_>`_   | Convert TBL restraints in ARIA XML format           |
+-------------------------+-----------------------------------------------------+
| `pdbdist <PDBDist_>`_   | Extract distance from a culled list of PDBs         |
+-------------------------+-----------------------------------------------------+
| `pdbstat <PDBStat_>`_   | Statistical analysis of ``pdbdist`` results         |
+-------------------------+-----------------------------------------------------+
| `iniconv <Iniconv_>`_   | Convert a INI file as csv for easy readability      |
+-------------------------+-----------------------------------------------------+


**Options**


.. rst-class:: table-hover


+--------------------------------------------------------+-----------------------------------------------------+
|  Name                                                  | Description                                         |
59
+========================================================+=====================================================+
60
61
62
63
64
65
66
67
68
69
70
71
72
| ``-h``, ``--help``                                     | show help message and exit                          |
+--------------------------------------------------------+-----------------------------------------------------+
| ``-o OUTPUT_DIRECTORY``, ``--output OUTPUT_DIRECTORY`` | Output directory (default: None)                    |
+--------------------------------------------------------+-----------------------------------------------------+
| ``-c CONF_FILE``, ``--conf CONF_FILE``                 | configuration file (default: None)                  |
+--------------------------------------------------------+-----------------------------------------------------+
| ``--nolog``                                            | Don't generate log files (default: False)           |
+--------------------------------------------------------+-----------------------------------------------------+
| ``-d``, ``--debug``                                    | Increase output verbosity (default: False)          |
+--------------------------------------------------------+-----------------------------------------------------+


Setup
73
+++++
74
75
Translate contact maps as distance restraints and setup ARIA infrastructure.

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
76
.. code-block:: shell
77

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
78
    ariaec setup [-options] seq infile [infile ...] -t intype [intype ...]
79
80
81
82
83
84
85
86
87


**Arguments**

.. rst-class:: table-hover


+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
88
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
89
90
| ``seq``                 | Sequence file [``FASTA``]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Fabrice Allain's avatar
Fabrice Allain committed
91
| ``infile [infile ...]`` | Contact or pdb file(s) used to build aria distance restraints                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
92
93
94
95
96
97
98
99
100
101
102
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. _ConKit: http://www.conkit.org/en/latest/


**Options**


.. rst-class:: table-hover


103
104
105
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
Fabrice Allain's avatar
Fabrice Allain committed
106
| ``-t intype [intype ...]``                             | Contact Map file format:sup:`*`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-d DISTFILE``, ``--distfile DISTFILE``               | Pdb or distance matrix iif distance_type set to distfile in conf file, use distances in the given file as target distance to build distance restraints                                                                                                                                                                                                                                                                                                                                                                  |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-s SSPRED``, ``--ssfile SSPRED``                     | Secondary structure prediction file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-p ARIAPROJECT``, ``--ariaproject ARIAPROJECT``      | ARIA project file. This project will be updated with data generated during the ``ariaec setup`` call                                                                                                                                                                                                                                                                                                                                                                                                                    |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-r SEQRANGE``, ``--range SEQRANGE``                  | Index range if we don't want tu use the whole sequence and map                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-n REF``, ``--native REF``                           | Native pdb. Allow TP/FP detection                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--hb HB``                                            | H-bonds contact file (eg: metapsicov.hb)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--ssidx``                                            | Use secondary structure index                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-filter``                                        | Do not filter contact map                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--extract-all``                                      | Extract data or all data and parameters if an ARIA project is defined with ``-p`` option                                                                                                                                                                                                                                                                                                                                                                                                                                |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :sup:`*` Accepted contact map formats combining formats supported by ConKit_ with few supplementary formats: ``gremlin``, ``pconsc1``, ``pconsc3``, ``pconsc2``, ``bbcontacts``, ``metapsicov_stg1``, ``membrain``, ``metapsicovhb``, ``comsat``, ``casprr``, ``ccmpred``, ``plm``, ``bclcontact``, ``epcmap``, ``evfold``, ``native``, ``pconsc``, ``psicov``, ``freecontact``, ``genericstructure``, ``ncont``, ``plmc``, ``plmdca``, ``metapsicov_stg2``, ``native_full``, ``metapsicov``, ``evcoupling``, ``contactlist``, ``plmev``, ``mmcif``, ``casp``, ``pdb``, ``flib`` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
128
129
130


Bbconv
131
++++++
132
133
134
Translate BBcontacts as distance restraints which can be used during
`setup <Setup_>`_.

Fabrice Allain's avatar
Fabrice Allain committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
.. code-block:: shell

    ariaec bbconv [-h] contactfile sspred seq [msa] -t contactype


**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``contactfile``         | contacts file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``sspred``              | PSIPRED secondary structure prediction file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``seq``                 | sequence file [FASTA]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``msa``                 | MSA [FASTA] used to compute diversityvalue (optional)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


**Options**

.. rst-class:: table-hover

+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``-t intype``                                          | Contact Map file format:sup:`*`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :sup:`*` Accepted contact map formats combining formats supported by ConKit_ with few supplementary formats: ``gremlin``, ``pconsc1``, ``pconsc3``, ``pconsc2``, ``bbcontacts``, ``metapsicov_stg1``, ``membrain``, ``metapsicovhb``, ``comsat``, ``casprr``, ``ccmpred``, ``plm``, ``bclcontact``, ``epcmap``, ``evfold``, ``native``, ``pconsc``, ``psicov``, ``freecontact``, ``genericstructure``, ``ncont``, ``plmc``, ``plmdca``, ``metapsicov_stg2``, ``native_full``, ``metapsicov``, ``evcoupling``, ``contactlist``, ``plmev``, ``mmcif``, ``casp``, ``pdb``, ``flib`` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


170
171

Maplot
172
++++++
173
174
Contactmap analysis and visualisation tool.

Fabrice Allain's avatar
Fabrice Allain committed
175
176
177
178
.. code-block:: shell

    ariaec maplot [-h] [--filter] [--onlyreport] [--no-filter] [--ssidx] [--prefix] [--prefixname PREFIXNAME] seq sspred infile [infile ...] -t intype [intype ...] --merge mergetype [mergetype ...]

179
180
181
182
183
184
185
186
187
188
189
**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``seq``                 | Sequence file [``FASTA``]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``sspred``              | Secondary structure prediction file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Fabrice Allain's avatar
Fabrice Allain committed
190
| ``infile [infile ...]`` | Contact or pdb file(s) used to build aria distance restraints                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
191
192
193
194
195
196
197
198
199
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

**Options**

.. rst-class:: table-hover

+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
Fabrice Allain's avatar
Fabrice Allain committed
200
| ``-t intype [intype ...]``                             | Contact Map file format:sup:`*`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
201
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Fabrice Allain's avatar
Fabrice Allain committed
202
| ``--merge mergetype [mergetype ...]``                  | Merge given contact types with other maps                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--filter``                                           | Use contact list filter and top n contacts selection                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--onlyreport``                                       | Generate only report file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-filter``                                        | Do not filter contact map                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--ssidx``                                            | Use secondary structure index                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--prefix``                                           | Generate prefix for file names                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--prefixname PREFIXNAME``                            | Prefix name for file names                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :sup:`*` Accepted contact map formats combining formats supported by ConKit_ with few supplementary formats: ``gremlin``, ``pconsc1``, ``pconsc3``, ``pconsc2``, ``bbcontacts``, ``metapsicov_stg1``, ``membrain``, ``metapsicovhb``, ``comsat``, ``casprr``, ``ccmpred``, ``plm``, ``bclcontact``, ``epcmap``, ``evfold``, ``native``, ``pconsc``, ``psicov``, ``freecontact``, ``genericstructure``, ``ncont``, ``plmc``, ``plmdca``, ``metapsicov_stg2``, ``native_full``, ``metapsicov``, ``evcoupling``, ``contactlist``, ``plmev``, ``mmcif``, ``casp``, ``pdb``, ``flib`` |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

219
220

Analysis
221
++++++++
222

Fabrice Allain's avatar
Fabrice Allain committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
Supplementary analysis results for a specific iteration from an ARIA project.

.. code-block:: shell

    ariaec analysis [-h] [-r REF] [-d RESTRAINT] [-p PREFIXNAME] project iteration_path list_name

**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``project``             | ARIA project file [XML]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``iteration_path``      | Iteration path used to run violation analysis                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``list_name``           | Name of restraint list analyzed in the tbl file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


**Options**

.. rst-class:: table-hover

+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``-r REF, --ref REF``                                  | Native pdb. Allow TP/FP detection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-d RESTRAINT``                                       | Distance restraint file (XML) used for violation analysis. Otherwise, use restraints of the current iteration                                                                                                                                                                                                                                                                                                                                                                                                           |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-p PREFIXNAME, --prefixname PREFIXNAME``             | Prefix name for file names                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
257
258
259


PDBQual
260
+++++++
Fabrice Allain's avatar
Fabrice Allain committed
261

262
263
264
Call PDB quality tools.


Fabrice Allain's avatar
Fabrice Allain committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
.. code-block:: shell

    ariaec pdbqual [-h] infile [infile ...]

**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``infile [infile ...]`` | PDB file(s) used to run quality tools with aria API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+



281
TBL2XML
282
+++++++
Fabrice Allain's avatar
Fabrice Allain committed
283

284
285
Convert TBL restraints in ARIA XML format.

Fabrice Allain's avatar
Fabrice Allain committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
.. code-block:: shell

    ariaec tbl2xml [-h] molecule.xml list_name infile.tbl [infile.tbl ...]

**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``molecule.xml``        | ARIA molecule file [XML]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``list_name``           | Restraint list name in the tbl file                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``infile.tbl``          | TBL distance restraint file(s)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


305
306

PDBDist
307
+++++++
Fabrice Allain's avatar
Fabrice Allain committed
308

309
310
Extract distance from a culled list of PDBs.

Fabrice Allain's avatar
Fabrice Allain committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
.. code-block:: shell

    ariaec pdbdist [-h] [--cullist CULLED_PDB_LIST] [--pdbdir PDB_FOLDER]


**Options**

.. rst-class:: table-hover

+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``--cullist CULLED_PDB_LIST``                          | Culled list of pdb files from PISCES server  :sup:`*`                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--pdbdir PDB_FOLDER``                                | Folder containing pdb file entries                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :sup:`*` : G. Wangand R. L. Dunbrack, Jr. PISCES: a protein sequence culling server. Bioinformatics, 19:1589-1591, 2003.                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


331
PDBStat
332
+++++++
Fabrice Allain's avatar
Fabrice Allain committed
333

Fabrice  ALLAIN's avatar
Fabrice ALLAIN committed
334
Statistical analysis of `pdbdist <PDBDist>`_ results.
335

Fabrice Allain's avatar
Fabrice Allain committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364

.. code-block:: shell

    ariaec pdbstat [-h] [-j N_JOBS] [--min] pdbdists

**Arguments**

.. rst-class:: table-hover

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                   | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+=========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``pdbdists``            | PDB distance file in csv format                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


**Options**

.. rst-class:: table-hover

+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+========================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``-j N_JOBS``                                          | Number of cpus used to run mixture in parallel. By default, use max of available cpus                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--min``                                              | Compute stats only on a minimized list of atom (CA, CB and 1 SC)                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


365
IniConv
366
+++++++
Fabrice Allain's avatar
Fabrice Allain committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384

Convert a configuration file (INI format) as csv for readability purpose.


.. code-block:: shell

    ariaec iniconv [-h] confile [confile ...]

**Arguments**

.. rst-class:: table-hover

+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Name                    | Short description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+==========================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| ``confile [confile ...]``| configuration file(s)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

385
386
387
388


.. Hyperlinks
.. [1] :command:`ec2aria` for older versions