sources/alscript/doc/alscript/subsubsection3_16_1_4.html

   1 <HEAD>
   2 <TITLE> STEP 2 COMMANDS</TITLE>
   3 </HEAD>
   4 <BODY><P>
   5  <HR> <A NAME=tex2html393 HREF=subsection3_16_2.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html391 HREF=subsection3_16_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html387 HREF=subsubsection3_16_1_3.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html395 HREF=tableofcontents3_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/contents_motif.gif"></A> <BR>
   6 <B> Next:</B> <A NAME=tex2html394 HREF=subsection3_16_2.html> AMPS Block file </A>
   7 <B>Up:</B> <A NAME=tex2html392 HREF=subsection3_16_1.html> ALSCRIPT Command Summary</A>
   8 <B> Previous:</B> <A NAME=tex2html388 HREF=subsubsection3_16_1_3.html> OPTIONAL STEP 1 </A>
   9 <HR> <P>
  10 <H3><A NAME=SECTION00016140000000000000> STEP 2 COMMANDS</A></H3>
  11 <P>
  12 All these are optional formatting commands.
  13 <P>
  14 IMPORTANT PLEASE READ THIS NOTE:
  15 <P>
  16 For those commands that accept region definitions (e.g. SURROUND_CHARS) it
  17 is easiest to think of the region being defined in terms of X and Y
  18 coordinates, where X is the sequence residue coordinate and Y is the
  19 sequence number coordinate.  Thus 3 7 means the 3rd residue in sequence 7.
  20 3 7 12 42 means the rectangular box bounded by residue 3 of sequence 7 and
  21 residue 12 of sequence 42.
  22 <P>
  23 SURROUND_CHARS &lt;string&gt; ALL
  24 <P>
  25 Draw lines round, but not between the characters that are in the string.
  26 e.g.
  27 <P>
  28 SURROUND_CHARS GP ALL
  29 <P>
  30 will draw lines round all G and P characters in the alignment, but not
  31 between adjacent G and P characters.
  32 <P>
  33 SURROUND_CHARS &lt;string&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
  34 <P>
  35 Similar command, but the surrounding is restricted to the region defined by
  36 the four integers.
  37 <P>
  38 e.g.
  39 <P>
  40 SURROUND_CHARS ILVW 3 12 7 32
  41 <P>
  42 would surround ILVW characters that occur in the region defined
  43 from residue positions 3-7 of sequences 12 to 32.
  44 <P>
  45 SHADE_CHARS &lt;string&gt; ALL &lt;float&gt;
  46 <P>
  47 Shade all characters in the &lt;string&gt; by the grey value given by &lt;float&gt;.
  48 e.g.
  49 <P>
  50 SHADE_CHARS GP ALL 0.5
  51 <P>
  52 would shade all G and P characters in the alignment by the grey value 0.5.
  53 <P>
  54 SHADE_CHARS  &lt;string&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;float&gt;
  55 <P>
  56 restricts the shading to the region defined by the four integers.  Thus
  57 <P>
  58 SHADE_CHARS ILVW 3 12 7 32 0.7
  59 <P>
  60 would shade I L V and W characters from residues 3-7 of sequences 12-32
  61 inclusive with a grey value of 0.7.
  62 <P>
  63 FONT_CHARS &lt;string&gt; ALL &lt;int&gt;
  64 <P>
  65 e.g.
  66 <P>
  67 FONT_CHARS GP ALL 7
  68 <P>
  69 would use font 7 to write out all G and P characters.  Font 7 MUST have been
  70 defined using the DEFINE_FONTcommands above.
  71 <P>
  72 FONT_CHARS  &lt;string&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
  73 <P>
  74 Similar to previous command, but restricts the effect to the region defined
  75 by the first four integers.  The font must have been defined by the
  76 DEFINE_FONT command.
  77 <P>
  78 e.g.
  79 <P>
  80 FONT_CHARS ILVW 3 45 9 70 7
  81 <P>
  82 Would set the font to 7 for I L V and W characters for residues 3-9 of
  83 sequences 45-70 inclusive.  The font must have been defined by the
  84 DEFINE_FONT command.
  85 <P>
  86 FONT_REGION &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
  87 <P>
  88 Define the font to use throughout the region specified by the first four
  89 integers.
  90 <P>
  91 e.g.
  92 <P>
  93 FONT_REGION 3 12 20 40 10
  94 <P>
  95 Use font 10 for residues from residues 3-20 of sequences 12-40.  The font
  96 must have been defined using the DEFINE_FONTcommand.
  97 <P>
  98 FONT_RESIDUE &lt;int&gt; &lt;int&gt; &lt;int&gt;
  99 <P>
 100 Set the font for use with a single residue position - most useful when used
 101 with the TEXT command.
 102 <P>
 103 e.g.
 104 <P>
 105 FONT_RESIDUE 3 7 2
 106 <P>
 107 Use font 2 for residue 3 of sequence 7.  Font 2 must have been defined using
 108 the DEFINE_FONT command.
 109 <P>
 110 LINE &lt;string&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
 111 <P>
 112 There are four commands of this type for drawing horizontal or vertical lines
 113 on the alignment.
 114 <P>
 115 LINE LEFT &lt;int&gt; &lt;int&gt; &lt;int&gt;
 116 <P>
 117 Draw a line to the left of the character positions indicated.
 118 <P>
 119 e.g.
 120 <P>
 121 LINE LEFT 3 12 24
 122 <P>
 123 Draw a vertical line starting at residue 3 of sequence 12 and ending at
 124 residue 3 of sequence 24.
 125 <P>
 126 LINE TOP 3 12 24
 127 <P>
 128 Draw a horizontal line above the character positions from residue 3 of
 129 sequence 12 to residue 24 of sequence 12.
 130 <P>
 131 Similar commands are:
 132 <P>
 133 LINE BOTTOM &lt;int&gt; &lt;int&gt; &lt;int&gt;  Draw a line at bottom of character position.
 134 <P>
 135 LINE RIGHT  &lt;int&gt; &lt;int&gt; &lt;int&gt;  Draw a line at right of character position.
 136 <P>
 137 BOX_REGION &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
 138 <P>
 139 Draw a box around the region indicated by the four integers.
 140 <P>
 141 e.g.
 142 <P>
 143 BOX_REGION 2 5 30 7
 144 <P>
 145 Would box from residue 2 of sequence 5 to residue 30 of sequence 7.
 146 <P>
 147 SHADE_REGION &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;float&gt;
 148 <P>
 149 Shade the region indicated by the integers with the grey value shown by the
 150 float.
 151 e.g.
 152 <P>
 153 SHADE_REGION 30 40 35 46 0.2
 154 <P>
 155 Would shade from residue 30-35 of sequences 40-46 with a grey value of 0.2.
 156 <P>
 157 SHADE_RES &lt;int&gt; &lt;int&gt; &lt;float&gt;
 158 <P>
 159 Shade just one amino acid with the grey value.
 160 <P>
 161 e.g.
 162 <P>
 163 SHADE_RES 3 4 0.7
 164 <P>
 165 Shades residue 3 of sequence 7. (Note:  this can also be achieved with the
 166 <P>
 167 SHADE_REGION command, but requires 2 extra numbers)
 168 <P>
 169 TEXT &lt;int&gt; &lt;int&gt; &lt;qstring&gt;
 170 <P>
 171 Place the text string at the location indicated.
 172 <P>
 173 e.g.
 174 <P>
 175 TEXT 30 70 &quot;Active Site His&quot;
 176 <P>
 177 would put the text Active Site His starting at position 30 of sequence
 178 70.  (Use FONT_RESIDUE or FONT_REGION commands to set the font of the
 179 text).  Text added with the TEXT command will not be split across page
 180 breaks, so you may in some circumstances need to fiddle a little with
 181 the location/pointsize for the text to get the desired result.
 182 <P>
 183 ID_FONT ALL &lt;int&gt;
 184 <P>
 185 Set the font for all identifier codes to the font number shown by &lt;int&gt;.
 186 e.g.
 187 <P>
 188 ID_FONT ALL 3
 189 <P>
 190 Would set all the identifier codes to font 3.
 191 <P>
 192 ID_FONT &lt;int&gt; &lt;int&gt;
 193 <P>
 194 Set the font for a specific identifier to font number.
 195 e.g.
 196 <P>
 197 ID_FONT 12 4
 198 <P>
 199 Use font 4 for the identifer of sequence 12, default font for all other
 200 identifiers.
 201 <P>
 202 SUB_CHARS ALL &lt;char&gt; &lt;char&gt;
 203 <P>
 204 Substitute the characters indicated.
 205 <P>
 206 e.g.
 207 <P>
 208 SUB_CHARS ALL + *
 209 <P>
 210 would change all occurences of + to * in the alignment.
 211 <P>
 212 SUB_CHARS &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;char&gt; &lt;char&gt;
 213 <P>
 214 restrict the substitution to the region shown.
 215 <P>
 216 e.g.
 217 <P>
 218 SUB_CHARS 1 1 7 8 %*
 219 <P>
 220 would substitute * for %from residue 1-7 of sequences 1-8.
 221 NOTE:  To substitute for or with  the space character use the word SPACE.
 222 e.g. to change all space characters to -.
 223 <P>
 224 SUB_CHARS ALL SPACE -
 225 <P>
 226 SUB_ID &lt;int&gt; &lt;qstring&gt;
 227 <P>
 228 Replace the numbered identifier by the string.
 229 e.g.
 230 <P>
 231 SUB_ID 34 &quot;Predicted Secondary Structure&quot;
 232 <P>
 233 would replace whatever the identifier of sequence 34 was, by the text shown.
 234 This is useful when used in conjunction with the ADD_SEQ command shown under
 235 the STEP 1 commands.
 236 <P>
 237 INVERSE_CHARS &lt;string&gt; ALL/Range (similar syntax to FONT_CHARS but no
 238 font number)
 239 <P>
 240 Print the selected characters in white.  This clearly will only work
 241 if you first use the SHADE_CHARScommand to shade the characters with
 242 something other than white.
 243 <P>
 244 CCOL_CHARS &lt;string&gt; ALL &lt;int&gt;
 245 <P>
 246 Colour all characters in the &lt;string&gt; by the colour defined by &lt;int&gt;.
 247 <P>
 248 e.g.
 249 <P>
 250 CCOL_CHARS GP ALL 12
 251 <P>
 252 would colour all G and P characters in the alignment by the colour 12.
 253 This colour MUST have been defined by the DEFINE_COLOUR command.
 254 <P>
 255 CCOL_CHARS  &lt;string&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
 256 <P>
 257 restricts the colouring to the region defined by the four integers.  Thus
 258 <P>
 259 CCOL_CHARS ILVW 3 12 7 32 7
 260 <P>
 261 would colour I L V and W characters from residues 3-7 of sequences 12-32
 262 inclusive with the colour 7.
 263 <P>
 264 SCOL_CHARS:  This has identical syntax to SCOL_CHARS, but colours the
 265 background of the character, rather than the letter itself.
 266 <P>
 267 COLOUR_REGION  &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt; &lt;int&gt;
 268 <P>
 269 COLOR_REGIONColour the region indicated by the integers with the colour number given
 270 as the last number.
 271 <P>
 272 e.g.
 273 <P>
 274 COLOUR_REGION 30 40 35 46 2
 275 <P>
 276 Would colour from residue 30-35 of sequences 40-46 with the colour 2.
 277 <P>
 278 COLOUR_RES &lt;int&gt; &lt;int&gt; &lt;int&gt;
 279 <P>
 280 Colour just one amino acid with the defined colour.
 281 <P>
 282 e.g.
 283 <P>
 284 COLOUR_RES 3 4 7
 285 <P>
 286 Colours residue 3 of sequence 7. (Note:  this can also be achieved with the
 287 COLOUR_REGION command, but requires 2 extra numbers)
 288 <P>
 289 <HR> <A NAME=tex2html393 HREF=subsection3_16_2.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html391 HREF=subsection3_16_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html387 HREF=subsubsection3_16_1_3.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html395 HREF=tableofcontents3_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/contents_motif.gif"></A> <BR>
 290 <B> Next:</B> <A NAME=tex2html394 HREF=subsection3_16_2.html> AMPS Block file </A>
 291 <B>Up:</B> <A NAME=tex2html392 HREF=subsection3_16_1.html> ALSCRIPT Command Summary</A>
 292 <B> Previous:</B> <A NAME=tex2html388 HREF=subsubsection3_16_1_3.html> OPTIONAL STEP 1 </A>
 293 <HR> <P>
 294 <HR>
 295
 296 </BODY>
 297 <P><ADDRESS>
 298 gjb@bioch.ox.ac.uk
 299 </ADDRESS>