JPRED-2 Add alscript to the Git repository
[jpred.git] / sources / alscript / doc / alscript / section3_13.html
diff --git a/sources/alscript/doc/alscript/section3_13.html b/sources/alscript/doc/alscript/section3_13.html
new file mode 100644 (file)
index 0000000..8d77a5e
--- /dev/null
@@ -0,0 +1,65 @@
+<HEAD>
+<TITLE> The MASK command family</TITLE>
+</HEAD>
+<BODY><P>
+ <HR> <A NAME=tex2html277 HREF=subsection3_13_1.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/next_motif.gif"></A> <A NAME=tex2html275 HREF=alscript.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/up_motif.gif"></A> <A NAME=tex2html269 HREF=section3_12.html><IMG ALIGN=MIDDLE SRC="http://geoff.biop.ox.ac.uk/latex2html/previous_motif.gif"></A> <A NAME=tex2html279 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=tex2html278 HREF=subsection3_13_1.html> Summary of mask </A>
+<B>Up:</B> <A NAME=tex2html276 HREF=alscript.html>No Title</A>
+<B> Previous:</B> <A NAME=tex2html270 HREF=section3_12.html> Using Colour</A>
+<HR> <P>
+<H1><A NAME=SECTION00013000000000000000> The MASK command family</A></H1>
+<P>
+The idea behind the MASK command is to build up a set of character
+positions that will subsequently be boxed, shaded, set in a particular
+font, etc.  For example, lets say we want to box the most frequently
+occuring character at each position in an alignment.
+<P>
+The command
+<P>
+mask SETUP
+<P>
+tells ALSCRIPT to prepare a mask.
+<P>
+mask FRE ALL
+<P>
+specifies that the most frequently occuring character at each position
+in the alignment will be masked.  This command can be restricted to a
+region of the alignment using: mask FRE sx sy ex ey, where sx etc
+define the region in the same way as for font_region  and other commands.
+<P>
+mask BOX ALL
+<P>
+Tells ALSCRIPT to create the boxing lines that will separate the masked
+characters from non-masked characters - this command may also be
+restricted to a region of the alignment.
+<P>
+The mask can be reset for re-use using the command:
+<P>
+mask RESET
+<P>
+Two further commands define which characters can be used when
+calculating the mask.  This allows gap-characters, or other amino acids
+to be excluded from the calculation to avoid unwanted boxing.
+<P>
+mask LEGAL &quot;AVLI&quot;
+<P>
+defines the AVL and I as the only characters that will be used when
+calculating the mask.
+<P>
+mask ILLEGAL &quot;.-_&quot;
+<P>
+defines .- and _ as characters that will not be used when calculating
+the mask.  NOTE:  the blank character &quot; &quot; cannot be defined in this way.
+To avoid boxing &quot; &quot; characters substitute blanks for something else
+(using SUB_CHARS), calculate the mask, then substitute back.
+<P>
+<HR>
+<UL> 
+<LI> <A NAME=tex2html280 HREF=subsection3_13_1.html#SECTION00013100000000000000> Summary of mask commands</A>
+</UL>
+<HR>
+
+</BODY>
+<P><ADDRESS>
+gjb@bioch.ox.ac.uk
+</ADDRESS>
\ No newline at end of file