JPRED-2 Add alscript to the Git repository
[jpred.git] / sources / alscript / doc / alscript / subsubsection3_16_1_3.html
1 <HEAD>
2 <TITLE> OPTIONAL STEP 1 COMMANDS</TITLE>
3 </HEAD>
4 <BODY><P>
5  <HR> <A NAME=tex2html384 HREF=subsubsection3_16_1_4.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html382 HREF=subsection3_16_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html376 HREF=subsubsection3_16_1_2.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html386 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=tex2html385 HREF=subsubsection3_16_1_4.html> STEP 2 COMMANDS</A>
7 <B>Up:</B> <A NAME=tex2html383 HREF=subsection3_16_1.html> ALSCRIPT Command Summary</A>
8 <B> Previous:</B> <A NAME=tex2html377 HREF=subsubsection3_16_1_2.html> REQUIRED STEP 1 </A>
9 <HR> <P>
10 <H3><A NAME=SECTION00016130000000000000> OPTIONAL STEP 1 COMMANDS</A></H3>
11 <P>
12 ADD_SEQ &lt;int&gt; &lt;int&gt;
13 <P>
14 Allows extra sequence positions to be created in an existing alignment.  This
15 permits additional annotations to be interspaced either above, below, or
16 anywhere in the middle of an alignment.  For example:
17 <P>
18 ADD_SEQ 0 10
19 <P>
20 would create an additional 10 sequences - all set to the blank character
21 before the first sequence in the block file that has been read in.
22 <P>
23 ADD_SEQ 3 1
24 <P>
25 would add an extra sequence after sequence 3.
26 <P>
27 IMPORTANT: If you use the ADD_SEQ facility to add sequences anywhere except 
28 after the last sequence, then remember that the sequence
29 numbers will alter.   All formatting commands that follow this command
30 must use the new sequence numbering.  Thus in the first example:
31 <P>
32 ADD_SEQ 0 10
33 <P>
34 what was sequence number 1 becomes sequence 11.  Sequences 1-10 are
35 the new blank sequences to be used for annotation.  Note that the
36 sequence numbers only change for commands AFTER the SETUP command,
37 thus, multiple add_seq commands refer to the sequence number as
38 implied by the block file.
39 <P>
40 POINTSIZE &lt;int&gt;
41 <P>
42 Defines the pointsize to be used to scale the plot and space the characters.
43 Default is 10 point.
44 <P>
45 NUMBER_SEQSIf present, then the sequence number is output with the identifier
46 code.  This is useful for finding the coordinates of residues to box
47 or otherwise highlight.
48 <P>
49 LANDSCAPE
50 <P>
51 Specifies that alignments will be plotted with the longest paper axis 
52 horizontal.  (Can get longer alignments on a page this way).
53 <P>
54 PORTRAIT
55 <P>
56 Specifies that alignments will be plotted with the longest paper axis vertical
57 (can get more sequences on a page this way).
58 <P>
59 IDENT_WIDTH &lt;int&gt;
60 <P>
61 Units are characters.
62 <P>
63 Reserves &lt;int&gt; characters at left of every page for plotting
64 identifiers.  Note that not all this space need be used, if a smaller
65 pointsize is used to plot out the identifier codes, than is used for
66 the main alignment.
67 <P>
68 LINE_WIDTH_FACTOR &lt;float&gt;
69 <P>
70 Value greater than 0 that scales the default line width.  The linewidth
71 is obtained by multiplying the pointsize by this factor.
72 <P>
73 X_SPACE_FACTOR &lt;float&gt;
74 <P>
75 Y_SPACE_FACTOR &lt;float&gt;
76 <P>
77 This determines the spacing between adjacent residues in the X and Y
78 directions.  The spacing is calculated as: POINTSIZE + POINTSIZE *
79 X_SPACE_FACTORor POINTSIZE + POINTSIZE * Y_SPACE_FACTOR as
80 appropriate.  Defaults are 0.2 and 0.0 respectively.
81 <P>
82 X_SHIFT_FACTOR &lt;float&gt;
83 <P>
84 Y_SHIFT_FACTOR &lt;float&gt;
85 <P>
86 These determine the shift relative to the residue drawing position
87 that is given to the boxing lines.  The shift is calculated as
88 follows
89 <P>
90 (POINTSIZE + POINTSIZE * X_SPACE_FACTOR) *  X_SHIFT_FACTOR 
91 similarly for Y_SHIFT_FACTOR.
92 <P>
93 The defaults are 0.3 and 0.0 respectively.
94 <P>
95 Fiddling with the X_SPACE/SHIFT values is useful to fine tune the
96 appearance of the alignment.
97 <P>
98 MAX_INPUT_LEN &lt;int&gt;
99 <P>
100 Units are characters.
101 Defines the maximum number of characters possible in the input line
102 length.  This must be  greater than the maximum number of sequences
103 (MAX_NSEQ).
104 <P>
105 e.g.  MAX_INPUT_LEN 600
106 <P>
107 Increases the default value of 500 characters to 600 characters.
108 <P>
109 MAX_NSEQ &lt;int&gt;
110 <P>
111 Units are characters.  Defines the maximum number of sequences that
112 may be read by the program.  This parameter has a large default (500).
113 You may need to reduce it on computers with small memories.
114 <P>
115 MAX_ILEN &lt;int&gt;
116 <P>
117 Units are characters.
118 The maximum length allowed for a sequence identifier code.
119 <P>
120 MAX_SEQ_LEN &lt;int&gt;
121 <P>
122 Defines the maximum length allowed for a sequence alignment - this may
123 need to be reduced from the 8000 default value on smaller computers.
124 <P>
125 X_OFFSET &lt;int&gt;
126 Units of points (1/72 inch).
127 <P>
128 Defines the offset along the X-axis that the alignments will be shifted prior
129 to printing.  Fiddle with this value to get a nice offset from the bottom left
130 hand corner of the page if your page size is not A4.
131 <P>
132 Y_OFFSET &lt;int&gt;
133 Units of points (1/72 inch).
134 <P>
135 As for X_OFFSET, only Y axis.
136 <P>
137 MAX_SIDE &lt;int&gt;
138 Units of inches.
139 <P>
140 Defines the length of the longest side of the printer page.
141 <P>
142 MIN_SIDE &lt;int&gt;
143 Units of inches.
144 <P>
145 Defines the length of the shortest side of the printer page.
146 <P>
147 VERTICAL_SPACING &lt;int&gt;
148 <P>
149 Defines the vertical spacing in character units between blocks of sequences
150 when more than one block will fit on a page - default is 0.
151 <P>
152 DEFINE_COLOUR &lt;int&gt; &lt;float&gt; &lt;float&gt; &lt;float&gt;
153 <P>
154 DEFINE_COLORDefines a colour - the first number is a number by which the colour will
155 be referred.  The following three numbers are the intensities of red,
156 green and blue respectively.  Thus:
157 <P>
158 DEFINE_COLOUR 1 0 0.2 0.8
159 <P>
160 sets colour number 1 to be a colour with no red, 0.2 green and 0.8 blue.
161 The exact appearance of this colour will depend on the output device. 
162 If you find suitable combinations of colours for your printer, then
163 please let me know and I shall distribute your suggestions with the
164 program.
165 <P>
166 DO_TICKSIf present, then tick marks are drawn below the numbers at the top of the page.
167 Otherwise no ticks are shown.
168 <P>
169 NUMBER_INT &lt;int&gt;
170 <P>
171 Specifies the interval for writing residue position numbers.  Default is 10
172 <P>
173 NO_NUMBERSSwitches all residue numbering off.
174 <P>
175 <HR> <A NAME=tex2html384 HREF=subsubsection3_16_1_4.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html382 HREF=subsection3_16_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html376 HREF=subsubsection3_16_1_2.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html386 HREF=tableofcontents3_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/contents_motif.gif"></A> <BR>
176 <B> Next:</B> <A NAME=tex2html385 HREF=subsubsection3_16_1_4.html> STEP 2 COMMANDS</A>
177 <B>Up:</B> <A NAME=tex2html383 HREF=subsection3_16_1.html> ALSCRIPT Command Summary</A>
178 <B> Previous:</B> <A NAME=tex2html377 HREF=subsubsection3_16_1_2.html> REQUIRED STEP 1 </A>
179 <HR> <P>
180 <HR>
181
182 </BODY>
183 <P><ADDRESS>
184 gjb@bioch.ox.ac.uk
185 </ADDRESS>