help/help/html/features/clarguments-ng-summary.html

   1 <html>
   2 <!--
   3  * Jalview is distributed in the hope that it will be useful, but
   4  * WITHOUT ANY WARRANTY; without even the implied warranty
   5  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   6  * PURPOSE.  See the GNU General Public License for more details.
   7  *
   8  * You should have received a copy of the GNU General Public License
   9  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  10  * The Jalview Authors are detailed in the 'AUTHORS' file.
  11  -->
  12 <title>Summary of Command Line Arguments (version 2.11.3.0 onwards)</title>
  13 <body>
  14
  15   <h1>Summary of Command Line Arguments (version 2.11.3.0 onwards)</h1>
  16
  17   <p>
  18   See <a href="clarguments-ng.html">Jalview Command Line Arguments (next generation)</a>
  19   for more explanation about using Jalview's command line arguments.
  20   </p>
  21
  22   <table border="1" cellpadding="3">
  23   <tr>
  24   <td><strong>argument</strong></td>
  25   <td><strong>action</strong></td>
  26   <td><strong>subval modifiers</strong> (optional)</td>
  27   <td align="center"><strong>linked</strong> (optional)</td>
  28   </tr>
  29
  30   <tr>
  31   <td><code>--open&nbsp;<em>filename/URL ...</em></code></td>
  32   <td>
  33   Opens one or more alignment files <em>filename</em> or URLs <em>URL</em> in new alignment windows.
  34   <a href="clarguments-ng.html#open">Examples</a>.
  35   </td>
  36   <td>
  37     <code>
  38       colour=<em>colourscheme</em>,
  39       title=<em>title</em>,
  40       features=<em>featurefile</em>,
  41       annotations=<em>annotationfile</em>,
  42       tree=<em>treefile</em>,
  43       showannotations,
  44       ssannotations,
  45       sortbytree,
  46       wrap
  47     </code>
  48   </td>
  49   <td align="center">&#x2713;</td>
  50   </tr>
  51
  52   <tr>
  53   <td><code>--append&nbsp;<em>filename/URL ...</em></code></td>
  54   <td>Appends one or more alignment files <em>filename</em> or URLs <em>URL</em> to the open alignment window (or opens a new alignment if none already open).</td>
  55   <td>
  56    <code>
  57       colour=<em>name</em>,
  58       title=<em>title</em>,
  59       features=<em>featurefile</em>,
  60       annotations=<em>annotationfile</em>,
  61       tree=<em>treefile</em>,
  62       showannotations,
  63       ssannotations,
  64       sortbytree,
  65       wrap
  66     </code>.
  67     <a href="clarguments-ng.html#append">Examples</a>.
  68    </td>
  69   <td align="center">&#x2713;</td>
  70   </tr>
  71
  72   <tr>
  73   <td><code>--title&nbsp;<em>"string""</em></code></td>
  74   <td>Specifies the title for the open alignment window as <em>string</em>.</td>
  75   <td></td>
  76   <td align="center">&#x2713;</td>
  77   </tr>
  78
  79   <tr>
  80   <td><code>--colour&nbsp;<em>name</em></code></td>
  81   <td>Applies the colour scheme <em>name</em> to the open alignment window.  Valid values for <em>name</em>are:
  82   <code>clustal</code>,
  83   <code>blosum62</code>,
  84   <code>pc-identity</code>,
  85   <code>zappo</code>,
  86   <code>taylor</code>,
  87   <code>gecos-flower</code>,
  88   <code>gecos-blossom</code>,
  89   <code>gecos-sunset</code>,
  90   <code>gecos-ocean</code>,
  91   <code>hydrophobic</code>,
  92   <code>helix-propensity</code>,
  93   <code>strand-propensity</code>,
  94   <code>turn-propensity</code>,
  95   <code>buried-index</code>,
  96   <code>nucleotide</code>,
  97   <code>nucleotide-ambiguity</code>,
  98   <code>purine-pyrimidine</code>,
  99   <code>rna-helices</code>,
 100   <code>t-coffee-scores</code>,
 101   <code>sequence-id</code>.
 102   <a href="clarguments-ng.html#colour">Examples</a>.
 103   <td></td>
 104   <td align="center">&#x2713;</td>
 105   </tr>
 106
 107   <tr>
 108   <td><code>--features&nbsp;<em>filename/URL</em></code></td>
 109   <td>Add a feature file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 110   <td></td>
 111   <td align="center">&#x2713;</td>
 112   </tr>
 113
 114
 115
 116   <tr>
 117   <td><code>--tree&nbsp;<em>filename/URL</em></code></td>
 118   <td>Add a tree file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 119   <td></td>
 120   <td align="center">&#x2713;</td>
 121   </tr>
 122
 123   <tr>
 124   <td><code>--sortbytree / --nosortbytree</code></td>
 125   <td>Enforces sorting (or not sorting) the alignment in the order of an attached phylogenetic tree.</td>
 126   <td></td>
 127   <td align="center">&#x2713;</td>
 128   </tr>
 129
 130
 131   <tr>
 132   <td><code>--annotations&nbsp;<em>filename/URL</em></code></td>
 133   <td>Add an annotations file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 134   <td></td>
 135   <td align="center">&#x2713;</td>
 136   </tr>
 137
 138   <tr>
 139   <td><code>--showannotations / --noshowannotations</code></td>
 140   <td>Enforces showing (or not showing) alignment annotations.</td>
 141   <td></td>
 142   <td align="center">&#x2713;</td>
 143   </tr>
 144
 145   <tr>
 146   <td><code>--wrap / --nowrap</code></td>
 147   <td>Enforces wrapped (or not wrapped) alignment formatting.</td>
 148   <td></td>
 149   <td align="center">&#x2713;</td>
 150   </tr>
 151
 152
 153   <tr>
 154   <td><code>--structure&nbsp;<em>filename/URL</em></code></td>
 155   <td>Load a structure file <em>filename</em> or URL <em>URL</em> associated with a sequence in the open alignment.  The sequence to be associated with can be specified with a following <code>--seqid</code> argument, or the subval modifier <code>seqid=<em>ID</em></code> can be used.  A subval <em>INDEX</em> can also be used to specify the <em>INDEX-th</em> sequence in the open alignment.</td>
 156   <td>
 157     <code>
 158       seqid=<em>sequenceid</em></code> or <code><em>INDEX</em>,
 159       paefile=<em>paefilename</em>,
 160       tempfac=<em>temperature factor type</em>,
 161       ssannotations,
 162       notempfac,
 163       structureviewer=<em>structure viewer</em>
 164     </code></td>
 165   <td align="center">&#x2713;</td>
 166   </tr>
 167
 168
 169   <tr>
 170   <td><code>--seqid&nbsp;<em>ID</em></code></td>
 171   <td>Specify the sequence name for the preceding <code>--structure</code> to be associated with.</td>
 172   <td></td>
 173   <td align="center">&#x2713;</td>
 174   </tr>
 175
 176
 177   <tr>
 178   <td><code>--paematrix&nbsp;<em>filename</em></code></td>
 179   <td>Add a PAE json matrix file <em>filename</em> to the preceding <code>--structure</code>.</td>
 180   <td></td>
 181   <td align="center">&#x2713;</td>
 182   </tr>
 183
 184
 185   <tr>
 186   <td><code>--tempfac&nbsp;<em>name</em></code></td>
 187   <td>Set the type of temperature factor.  Possible values for <em>name</em> are
 188     <code>default</code>,
 189     <code>plddt</code>
 190   </td>
 191   <td></td>
 192   <td align="center">&#x2713;</td>
 193   </tr>
 194
 195
 196   <tr>
 197   <td><code>--structureviewer&nbsp;<em>name</em></code></td>
 198   <td>Set the structure viewer to use to open the 3d structure file specified in previous <code>--structure</code> to <em>name</em>.  Possible values of <em>name</em> are:
 199   <br/>
 200     <code>none</code>,
 201     <br/>
 202     <code>jmol</code>,
 203     <br/>
 204     <code>chimera</code> <em>- requires installation, might need configuring in Preferences</em>,
 205     <br/>
 206     <code>chimerax</code> <em>- requires installation, might need configuring in Preferences</em>,
 207     <br/>
 208     <code>pymol</code> <em>- requires installation, might need configuring in Preferences</em>
 209   </td>
 210   <td></td>
 211   <td align="center">&#x2713;</td>
 212   </tr>
 213
 214
 215   <tr>
 216   <td><code>--notempfac</code></td>
 217   <td>Do not show the temperature factor annotation for the preceding <code>--structure</code></td>
 218   <td></td>
 219   <td align="center">&#x2713;</td>
 220   </tr>
 221
 222
 223   <tr>
 224   <td><code>--groovy&nbsp;<em>filename</em></code></td>
 225   <td>Process a groovy script in the file for the open alignment.</td>
 226   <td></td>
 227   <td align="center">&#x2713;</td>
 228   </tr>
 229
 230
 231   <tr>
 232   <td><code>--image&nbsp;<em>new filename</em></code></td>
 233   <td>Output an image of the open alignment window.  Format is specified by the subval modifier, a following <code>--type</code> argument or guessed from the file extension.  Valid formats/extensions are:
 234   <code>svg</code>,
 235   <code>png</code>,
 236   <code>eps</code>,
 237   <code>html</code>,
 238   <code>biojs</code>
 239   </td>
 240   <td>
 241     <code>type=<em>image format</em>,
 242     <code>textrenderer=<em>text format</em>
 243   </td>
 244   <td align="center">&#x2713;</td>
 245   </tr>
 246
 247   <tr>
 248   <td><code>--type&nbsp;<em>image format</em></code></td>
 249   <td>Set the image format for the preceding <code>--image</code>.  Valid values are:
 250   <code>svg</code>,
 251   <code>png</code>,
 252   <code>eps</code>,
 253   <code>html</code>,
 254   <code>biojs</code>
 255   </td>
 256   <td></td>
 257   <td align="center">&#x2713;</td>
 258   </tr>
 259
 260   <tr>
 261   <td><code>--textrenderer&nbsp;<em>text format</em></code></td>
 262   <td>Sets whether text in a vector image format (SVG, HTML, EPS) should be rendered as text or vector line-art.  Possible values are:
 263     <code>text</code>,
 264     <code>lineart</code>
 265   </td>
 266   <td></td>
 267   <td align="center">&#x2713;</td>
 268   </tr>
 269
 270   <tr>
 271   <td><code>--output&nbsp;<em>outputfilename</em></code></td>
 272   <td>Export the open alignment.  Format is specified by the subval modifier, a following <code>--format</code> argument or guessed from the file extension.  Valid formats/extensions are:
 273   <br/>
 274   Fasta (<code>fa, fasta</code>),
 275   <br/>
 276
 277   </td>
 278   <td></td>
 279   <td align="center">&#x2713;</td>
 280   </tr>
 281
 282
 283   <tr>
 284   <td><code>--&nbsp;<em></em></code></td>
 285   <td></td>
 286   <td></td>
 287   <td align="center">&#x2713;</td>
 288   </tr>
 289
 290
 291   <tr>
 292   <td><code>--&nbsp;<em></em></code></td>
 293   <td></td>
 294   <td></td>
 295   <td align="center">&#x2713;</td>
 296   </tr>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321   <tr>
 322   <td><code>--&nbsp;<em></em></code></td>
 323   <td></td>
 324   <td></td>
 325   <td align="center">&#x2713;</td>
 326   </tr>
 327
 328
 329
 330   </table>