JPRED-2 Add alscript to the Git repository
[jpred.git] / sources / alscript / doc / alscript / subsection3_13_1.html
diff --git a/sources/alscript/doc/alscript/subsection3_13_1.html b/sources/alscript/doc/alscript/subsection3_13_1.html
new file mode 100644 (file)
index 0000000..078e61a
--- /dev/null
@@ -0,0 +1,96 @@
+<HEAD>
+<TITLE> Summary of mask commands</TITLE>
+</HEAD>
+<BODY><P>
+ <HR> <A NAME=tex2html287 HREF=section3_14.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html285 HREF=section3_13.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html281 HREF=section3_13.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html289 HREF=tableofcontents3_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/contents_motif.gif"></A> <BR>
+<B> Next:</B> <A NAME=tex2html288 HREF=section3_14.html> Printing ALSCRIPT Files</A>
+<B>Up:</B> <A NAME=tex2html286 HREF=section3_13.html> The MASK command </A>
+<B> Previous:</B> <A NAME=tex2html282 HREF=section3_13.html> The MASK command </A>
+<HR> <P>
+<H2><A NAME=SECTION00013100000000000000> Summary of mask commands</A></H2>
+<P>
+mask SETUP             
+#Prepares for masking
+<P>
+mask LEGAL &lt;qstring&gt;   
+#defines characters to include in ID or FRE calcs - optional.
+<P>
+mask ILLEGAL &lt;qstring&gt; 
+#defines characters to exclude in ID or FRE calcs - optional.
+<P>
+mask ID ALL N
+#Calculates a mask that flags the character that occurs at least N
+times at a position.  The word ALL can be substituted by four numbers
+that define a region of the alignment.
+<P>
+mask FRE ALL
+#calculates a mask that flags the most frequently occuring amino acid
+at each position.  ALL may be replaced by four numbers defining a region
+of the alignment.
+<P>
+Multiple mask FRE or mask ID commands may be applied, using different
+LEGAL and ILLEGAL character definitions.  In this way more complex
+effects can be built up.
+<P>
+The mask command also allows characters that are identical to one
+sequence to be masked.
+<P>
+mask AGREE ALL N
+<P>
+will mask all positions that are identical to the Nth sequence.  Thus,
+for sequences that are very similar to a newly sequenced sequence, all
+characters identical to the new sequence can be boxed or shaded, or set
+in a different font or colour etc...
+<P>
+mask NOT ALL
+<P>
+allows the mask to be inverted.  Thus, all positions that are NOT in the
+mask now form the mask.  So, having done a mask AGREE, a mask NOT will
+allow the positions that are not identical to the selected sequence to
+be highlighted or substituted.
+<P>
+mask SUB ALL &lt;char&gt;
+<P>
+substitutes all characters in the mask with  the character &lt;char&gt;.
+<P>
+mask REGION ALL
+applies a mask to all residues  in  the defined region.
+<P>
+The following effects can now be applied to the masked characters:
+<P>
+mask BOX ALL 
+#boxes the masked residues - ie surrounds them by lines.
+<P>
+mask SHADE ALL &lt;grey&gt;
+#shades the masked residues by grey value.
+<P>
+mask FONT ALL &lt;fontnum&gt;
+#Uses font fontnum to output the masked residues.
+<P>
+mask INVERSE ALL 
+#Inverts the masked characters - ie outputs them in white.
+<P>
+mask CCOL ALL &lt;colnum&gt;
+#outputs the masked characters in the defined colour.
+<P>
+mask SCOL ALL &lt;colnum&gt;
+#outputs the backgrounds of the masked characters in the defined
+colour.
+<P>
+In all commands, the word ALL can be replaced by four numbers defining
+the region to which the command is applied.
+<P>
+mask RESET
+#resets the entire mask for re-use
+<P>
+<HR> <A NAME=tex2html287 HREF=section3_14.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html285 HREF=section3_13.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html281 HREF=section3_13.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html289 HREF=tableofcontents3_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/contents_motif.gif"></A> <BR>
+<B> Next:</B> <A NAME=tex2html288 HREF=section3_14.html> Printing ALSCRIPT Files</A>
+<B>Up:</B> <A NAME=tex2html286 HREF=section3_13.html> The MASK command </A>
+<B> Previous:</B> <A NAME=tex2html282 HREF=section3_13.html> The MASK command </A>
+<HR> <P>
+<HR>
+
+</BODY>
+<P><ADDRESS>
+gjb@bioch.ox.ac.uk
+</ADDRESS>
\ No newline at end of file