# $Id: mview_alig.pm,v 1.3 2003/06/10 09:33:20 letondal Exp $
# BioPerl module for Bio::Tools::Run::PiseApplication::mview_alig
#
# Cared for by Catherine Letondal <letondal@pasteur.fr>
#
# For copyright and disclaimer see below.
#
# POD documentation - main docs before the code

=head1 NAME

Bio::Tools::Run::PiseApplication::mview_alig

=head1 SYNOPSIS

  #

=head1 DESCRIPTION

Bio::Tools::Run::PiseApplication::mview_alig

      Bioperl class for:

	MVIEW	a multiple alignment viewer (N. P. Brown)

	References:

		Brown, N.P., Leroy C., Sander C. (1998). MView: A Web compatible database search or multiple alignment  viewer. Bioinformatics. 14(4):380-381.



      Parameters: 

        (see also:
          http://bioweb.pasteur.fr/seqanal/interfaces/mview_alig.html 
         for available values):


		mview_alig (String)

		alig (Sequence)
			Alignment File
			pipe: readseq_ok_alig

		in (Excl)
			Type of alignment (-in)

		from_phylip (String)

		ruler (Switch)
			Attach a ruler (-ruler)

		alignment (Switch)
			Show alignment (-alignment)

		consensus (Switch)
			Show consensus (-consensus)

		dna (Switch)
			Use DNA/RNA colormaps and/or consensus groups (-dna)

		coloring (Excl)
			Colour scheme (-coloring)

		threshold (Float)
			Threshold percentage for consensus coloring (-threshold)

		ignore (Excl)
			Ignore singleton or class group (-ignore)

		con_coloring (Excl)
			Basic style of coloring (-con_coloring)

		con_threshold (String)
			Consensus line thresholds (in range 50..100) (separated by commas) (-con_threshold)

		con_ignore (Excl)
			Ignore singleton or class group (-con_ignore)

		con_gaps (Switch)
			Count gaps during consensus computations (-con_gaps)

		top (Integer)
			Report top N hits (-top)

		range (String)
			Display column range M..N as numbered by ruler (M,N) (-range)

		maxident (Integer)
			Only report sequences with %identity <= N (-maxident)

		ref (Integer)
			Use row N or row identifier as %id entity reference (-ref)

		keep_only (String)
			Keep only the rows from start to end (separated by commas: start,end) (-keep)

		disc (String)
			Discard rows from start to end (separated by commas: start,end) (-disc)

		nops (String)
			Display rows unprocessed (separated by commas) (-nops)

		width (Integer)
			Paginate in N columns of alignment (-width)

		gap (String)
			Use this character as the gap (-gap)

		label0 (Switch)
			Switch off label: row number (-label0)

		label1 (Switch)
			Switch off label: identifier (-label1)

		label2 (Switch)
			Switch off label: description (-label2)

		label3 (Switch)
			Switch off label: scores (-label3)

		label4 (Switch)
			Switch off label: percent identity (-label4)

		html_output (Excl)
			HTML output

		pagecolor (String)
			Page backgound color (-pagecolor)

		textcolor (String)
			Page text color (-textcolor)

		linkcolor (String)
			Link color (-linkcolor)

		alinkcolor (String)
			Active link color (-alinkcolor)

		vlinkcolor (String)
			Visited link color (-vlinkcolor)

		alncolor (String)
			Alignment background color (-alncolor)

		symcolor (String)
			Alignment default text color (-symcolor)

		gapcolor (String)
			Alignment gap color (-gapcolor)

		bold (Switch)
			Use bold emphasis for coloured residues (-bold)

		css (Excl)
			Use Cascading Style Sheets (-css)

		html_output_file (OutFile)

		out (Excl)
			Output format (-out)

=head1 FEEDBACK

=head2 Mailing Lists

User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list.  Your participation is much appreciated.

  bioperl-l@bioperl.org              - General discussion
  http://bioperl.org/MailList.shtml  - About the mailing lists

=head2 Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
email or the web:

  bioperl-bugs@bioperl.org
  http://bioperl.org/bioperl-bugs/

=head1 AUTHOR

Catherine Letondal (letondal@pasteur.fr)

=head1 COPYRIGHT

Copyright (C) 2003 Institut Pasteur & Catherine Letondal.
All Rights Reserved.

This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=head1 DISCLAIMER

This software is provided "as is" without warranty of any kind.

=head1 SEE ALSO

=over

=item *

http://bioweb.pasteur.fr/seqanal/interfaces/mview_alig.html

=item *

Bio::Tools::Run::PiseApplication

=item *

Bio::Tools::Run::AnalysisFactory::Pise

=item *

Bio::Tools::Run::PiseJob

=back

=cut

#'
package Bio::Tools::Run::PiseApplication::mview_alig;

use vars qw(@ISA);
use strict;
use Bio::Tools::Run::PiseApplication;

@ISA = qw(Bio::Tools::Run::PiseApplication);

=head2 new

 Title   : new()
 Usage   : my $mview_alig = Bio::Tools::Run::PiseApplication::mview_alig->new($location, $email, @params);
 Function: Creates a Bio::Tools::Run::PiseApplication::mview_alig object.
           This method should not be used directly, but rather by 
           a Bio::Tools::Run::AnalysisFactory::Pise instance.
           my $factory = Bio::Tools::Run::AnalysisFactory::Pise->new();
           my $mview_alig = $factory->program('mview_alig');
 Example : -
 Returns : An instance of Bio::Tools::Run::PiseApplication::mview_alig.

=cut

sub new {
    my ($class, $location, $email, @params) = @_;
    my $self = $class->SUPER::new($location, $email);

# -- begin of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/mview_alig.pm

    $self->{COMMAND}   = "mview_alig";
    $self->{VERSION}   = "5.a";
    $self->{TITLE}   = "MVIEW";

    $self->{DESCRIPTION}   = "a multiple alignment viewer";

    $self->{OPT_EMAIL}   = 0;

    $self->{CATEGORIES}   =  [  

         "alignment:multiple",

         "display",
  ];

    $self->{AUTHORS}   = "N. P. Brown";

    $self->{REFERENCE}   = [

         "Brown, N.P., Leroy C., Sander C. (1998). MView: A Web compatible database search or multiple alignment  viewer. Bioinformatics. 14(4):380-381.",
 ];

    $self->{_INTERFACE_STANDOUT} = undef;
    $self->{_STANDOUT_FILE} = undef;

    $self->{TOP_PARAMETERS}  = [ 
	"mview_alig",
	"alig",
	"in",
	"from_phylip",
	"main_formatting_options",
	"alignment_options",
	"consensus_options",
	"hybrid_alignment_consensus_options",
	"general_row_column_filters",
	"general_formatting_options",
	"html_markup_options",
	"html_output_file",
	"html_file",
	"alig_file",
	"out",

    ];

    $self->{PARAMETERS_ORDER}  = [
	"mview_alig",
	"alig", 	# Alignment File
	"in", 	# Type of alignment (-in)
	"from_phylip",
	"main_formatting_options", 	# Main formatting options
	"ruler", 	# Attach a ruler (-ruler)
	"alignment", 	# Show alignment (-alignment)
	"consensus", 	# Show consensus (-consensus)
	"dna", 	# Use DNA/RNA colormaps and/or consensus groups (-dna)
	"alignment_options", 	# Alignment options
	"coloring", 	# Colour scheme (-coloring)
	"threshold", 	# Threshold percentage for consensus coloring (-threshold)
	"ignore", 	# Ignore singleton or class group (-ignore)
	"consensus_options", 	# Consensus options
	"con_coloring", 	# Basic style of coloring (-con_coloring)
	"con_threshold", 	# Consensus line thresholds (in range 50..100) (separated by commas) (-con_threshold)
	"con_ignore", 	# Ignore singleton or class group (-con_ignore)
	"hybrid_alignment_consensus_options", 	# Hybrid alignment and consensus options
	"con_gaps", 	# Count gaps during consensus computations (-con_gaps)
	"general_row_column_filters", 	# General row/column filters
	"top", 	# Report top N hits (-top)
	"range", 	# Display column range M..N as numbered by ruler (M,N) (-range)
	"maxident", 	# Only report sequences with %identity <= N (-maxident)
	"ref", 	# Use row N or row identifier as %id entity reference (-ref)
	"keep_only", 	# Keep only the rows from start to end (separated by commas: start,end) (-keep)
	"disc", 	# Discard rows from start to end (separated by commas: start,end) (-disc)
	"nops", 	# Display rows unprocessed (separated by commas) (-nops)
	"general_formatting_options", 	# General formatting options
	"width", 	# Paginate in N columns of alignment (-width)
	"gap", 	# Use this character as the gap (-gap)
	"label0", 	# Switch off label: row number (-label0)
	"label1", 	# Switch off label: identifier (-label1)
	"label2", 	# Switch off label: description (-label2)
	"label3", 	# Switch off label: scores (-label3)
	"label4", 	# Switch off label: percent identity (-label4)
	"html_markup_options", 	# HTML markup options
	"html_output", 	# HTML output
	"pagecolor", 	# Page backgound color (-pagecolor)
	"textcolor", 	# Page text color (-textcolor)
	"linkcolor", 	# Link color (-linkcolor)
	"alinkcolor", 	# Active link color (-alinkcolor)
	"vlinkcolor", 	# Visited link color (-vlinkcolor)
	"alncolor", 	# Alignment background color (-alncolor)
	"symcolor", 	# Alignment default text color (-symcolor)
	"gapcolor", 	# Alignment gap color (-gapcolor)
	"bold", 	# Use bold emphasis for coloured residues (-bold)
	"css", 	# Use Cascading Style Sheets (-css)
	"html_output_file",
	"html_file",
	"alig_file",
	"out", 	# Output format (-out)

    ];

    $self->{TYPE}  = {
	"mview_alig" => 'String',
	"alig" => 'Sequence',
	"in" => 'Excl',
	"from_phylip" => 'String',
	"main_formatting_options" => 'Paragraph',
	"ruler" => 'Switch',
	"alignment" => 'Switch',
	"consensus" => 'Switch',
	"dna" => 'Switch',
	"alignment_options" => 'Paragraph',
	"coloring" => 'Excl',
	"threshold" => 'Float',
	"ignore" => 'Excl',
	"consensus_options" => 'Paragraph',
	"con_coloring" => 'Excl',
	"con_threshold" => 'String',
	"con_ignore" => 'Excl',
	"hybrid_alignment_consensus_options" => 'Paragraph',
	"con_gaps" => 'Switch',
	"general_row_column_filters" => 'Paragraph',
	"top" => 'Integer',
	"range" => 'String',
	"maxident" => 'Integer',
	"ref" => 'Integer',
	"keep_only" => 'String',
	"disc" => 'String',
	"nops" => 'String',
	"general_formatting_options" => 'Paragraph',
	"width" => 'Integer',
	"gap" => 'String',
	"label0" => 'Switch',
	"label1" => 'Switch',
	"label2" => 'Switch',
	"label3" => 'Switch',
	"label4" => 'Switch',
	"html_markup_options" => 'Paragraph',
	"html_output" => 'Excl',
	"pagecolor" => 'String',
	"textcolor" => 'String',
	"linkcolor" => 'String',
	"alinkcolor" => 'String',
	"vlinkcolor" => 'String',
	"alncolor" => 'String',
	"symcolor" => 'String',
	"gapcolor" => 'String',
	"bold" => 'Switch',
	"css" => 'Excl',
	"html_output_file" => 'OutFile',
	"html_file" => 'Results',
	"alig_file" => 'Results',
	"out" => 'Excl',

    };

    $self->{FORMAT}  = {
	"mview_alig" => {
		"perl" => ' "mview" ',
	},
	"alig" => {
		"perl" => '" $value"',
	},
	"in" => {
		"perl" => '($value eq "phylip")? " -in msf " : " -in $value" ',
	},
	"from_phylip" => {
		"perl" => ' "fmtseq -p -f17 $alig > $alig.tmp; mv $alig.tmp $alig; "',
	},
	"main_formatting_options" => {
	},
	"ruler" => {
		"perl" => '($value)? " -ruler on":""',
	},
	"alignment" => {
		"perl" => '($value)? " " : " -alignment off"',
	},
	"consensus" => {
		"perl" => '($value)? " -consensus on":""',
	},
	"dna" => {
		"perl" => '($value)? " -dna":""',
	},
	"alignment_options" => {
	},
	"coloring" => {
		"perl" => '($value)? " -coloring $value":""',
	},
	"threshold" => {
		"perl" => '(defined $value && $value != $vdef)? " -threshold $value":""',
	},
	"ignore" => {
		"perl" => '($value && $value ne $vdef)? " -ignore $value" : ""',
	},
	"consensus_options" => {
	},
	"con_coloring" => {
		"perl" => '($value)? " -con_coloring $value":""',
	},
	"con_threshold" => {
		"perl" => '($value && $value ne $vdef)? " -con_threshold $value":""',
	},
	"con_ignore" => {
		"perl" => '($value && $value ne $vdef)? " -con_ignore $value" : ""',
	},
	"hybrid_alignment_consensus_options" => {
	},
	"con_gaps" => {
		"perl" => '($value)? "" : " -con_gaps off"',
	},
	"general_row_column_filters" => {
	},
	"top" => {
		"perl" => '(defined $value)? " -top $value":""',
	},
	"range" => {
		"perl" => '($value && ($value =~ s/,/:/g))? " -range $value":""',
	},
	"maxident" => {
		"perl" => '(defined $value && $value != $vdef)? " -maxident $value":""',
	},
	"ref" => {
		"perl" => '($value)? " -ref $value":""',
	},
	"keep_only" => {
		"perl" => '($value && ($value =~ s/,/../))? " -disc \\"/.*/\\" -keep $value" : "" ',
	},
	"disc" => {
		"perl" => '($value && ($value =~ s/,/../))? " -disc $value" : "" ',
	},
	"nops" => {
		"perl" => '($value)? " -nops $value" : "" ',
	},
	"general_formatting_options" => {
	},
	"width" => {
		"perl" => '(defined $value)? " -width $value":""',
	},
	"gap" => {
		"perl" => '($value)? " -gap $value" : " " ',
	},
	"label0" => {
		"perl" => '($value)? " -label0":""',
	},
	"label1" => {
		"perl" => '($value)? " -label1":""',
	},
	"label2" => {
		"perl" => '($value)? " -label2":""',
	},
	"label3" => {
		"perl" => '($value)? " -label3":""',
	},
	"label4" => {
		"perl" => '($value)? " -label4":""',
	},
	"html_markup_options" => {
	},
	"html_output" => {
		"perl" => '" -html $value"',
	},
	"pagecolor" => {
		"perl" => '($value)? " -pagecolor $value" : ""',
	},
	"textcolor" => {
		"perl" => '($value && $value ne $vdef)? " -textcolor $value" : ""',
	},
	"linkcolor" => {
		"perl" => '($value && $value ne $vdef)? " -linkcolor $value" : ""',
	},
	"alinkcolor" => {
		"perl" => '($value && $value ne $vdef)? " -alinkcolor $value" : ""',
	},
	"vlinkcolor" => {
		"perl" => '($value && $value ne $vdef)? " -vlinkcolor $value" : ""',
	},
	"alncolor" => {
		"perl" => '($value)? " -alncolor $value" : ""',
	},
	"symcolor" => {
		"perl" => '($value)? " -symcolor $value" : " "',
	},
	"gapcolor" => {
		"perl" => '($value)? " -gapcolor $value" : ""',
	},
	"bold" => {
		"perl" => '($value)? " -bold":""',
	},
	"css" => {
		"perl" => '($value eq "on")? " -css on" : ""',
	},
	"html_output_file" => {
		"perl" => '" > mview.html"',
	},
	"html_file" => {
	},
	"alig_file" => {
	},
	"out" => {
		"perl" => '($value eq "html")? "" : " -out $value"',
	},

    };

    $self->{FILENAMES}  = {
	"html_file" => 'mview.html',
	"alig_file" => 'mview*.out',

    };

    $self->{SEQFMT}  = {

    };

    $self->{GROUP}  = {
	"mview_alig" => 0,
	"alig" => 1000,
	"in" => 2,
	"from_phylip" => -10,
	"main_formatting_options" => 2,
	"ruler" => 2,
	"alignment" => 2,
	"consensus" => 2,
	"dna" => 2,
	"alignment_options" => 3,
	"coloring" => 3,
	"threshold" => 3,
	"ignore" => 3,
	"consensus_options" => 3,
	"con_coloring" => 3,
	"con_threshold" => 3,
	"con_ignore" => 3,
	"hybrid_alignment_consensus_options" => 3,
	"con_gaps" => 3,
	"general_row_column_filters" => 3,
	"top" => 3,
	"range" => 3,
	"maxident" => 3,
	"ref" => 3,
	"keep_only" => 3,
	"disc" => 3,
	"nops" => 3,
	"general_formatting_options" => 3,
	"width" => 3,
	"gap" => 3,
	"label0" => 3,
	"label1" => 3,
	"label2" => 3,
	"label3" => 3,
	"label4" => 3,
	"html_markup_options" => 3,
	"html_output" => 1,
	"pagecolor" => 3,
	"textcolor" => 3,
	"linkcolor" => 3,
	"alinkcolor" => 3,
	"vlinkcolor" => 3,
	"alncolor" => 3,
	"symcolor" => 3,
	"gapcolor" => 3,
	"bold" => 3,
	"css" => 3,
	"html_output_file" => 2000,
	"out" => 1,

    };

    $self->{BY_GROUP_PARAMETERS}  = [
	"from_phylip",
	"mview_alig",
	"html_file",
	"alig_file",
	"html_output",
	"out",
	"alignment",
	"consensus",
	"dna",
	"in",
	"main_formatting_options",
	"ruler",
	"ignore",
	"consensus_options",
	"con_coloring",
	"con_threshold",
	"con_ignore",
	"hybrid_alignment_consensus_options",
	"con_gaps",
	"general_row_column_filters",
	"top",
	"range",
	"maxident",
	"ref",
	"keep_only",
	"disc",
	"nops",
	"general_formatting_options",
	"width",
	"gap",
	"label0",
	"label1",
	"label2",
	"label3",
	"label4",
	"html_markup_options",
	"pagecolor",
	"textcolor",
	"linkcolor",
	"alinkcolor",
	"vlinkcolor",
	"alncolor",
	"symcolor",
	"gapcolor",
	"bold",
	"css",
	"alignment_options",
	"coloring",
	"threshold",
	"alig",
	"html_output_file",

    ];

    $self->{SIZE}  = {
	"con_threshold" => 50,
	"pagecolor" => 20,
	"textcolor" => 20,
	"linkcolor" => 20,
	"alinkcolor" => 20,
	"vlinkcolor" => 20,
	"alncolor" => 20,
	"symcolor" => 20,
	"gapcolor" => 20,

    };

    $self->{ISHIDDEN}  = {
	"mview_alig" => 1,
	"alig" => 0,
	"in" => 0,
	"from_phylip" => 1,
	"main_formatting_options" => 0,
	"ruler" => 0,
	"alignment" => 0,
	"consensus" => 0,
	"dna" => 0,
	"alignment_options" => 0,
	"coloring" => 0,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 0,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 1,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 0,

    };

    $self->{ISCOMMAND}  = {
	"mview_alig" => 1,
	"alig" => 0,
	"in" => 0,
	"from_phylip" => 0,
	"main_formatting_options" => 0,
	"ruler" => 0,
	"alignment" => 0,
	"consensus" => 0,
	"dna" => 0,
	"alignment_options" => 0,
	"coloring" => 0,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 0,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 0,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 0,

    };

    $self->{ISMANDATORY}  = {
	"mview_alig" => 0,
	"alig" => 1,
	"in" => 1,
	"from_phylip" => 0,
	"main_formatting_options" => 0,
	"ruler" => 0,
	"alignment" => 0,
	"consensus" => 0,
	"dna" => 0,
	"alignment_options" => 0,
	"coloring" => 0,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 1,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 0,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 1,

    };

    $self->{PROMPT}  = {
	"mview_alig" => "",
	"alig" => "Alignment File",
	"in" => "Type of alignment (-in)",
	"from_phylip" => "",
	"main_formatting_options" => "Main formatting options",
	"ruler" => "Attach a ruler (-ruler)",
	"alignment" => "Show alignment (-alignment)",
	"consensus" => "Show consensus (-consensus)",
	"dna" => "Use DNA/RNA colormaps and/or consensus groups (-dna)",
	"alignment_options" => "Alignment options",
	"coloring" => "Colour scheme (-coloring)",
	"threshold" => "Threshold percentage for consensus coloring (-threshold)",
	"ignore" => "Ignore singleton or class group (-ignore)",
	"consensus_options" => "Consensus options",
	"con_coloring" => "Basic style of coloring (-con_coloring)",
	"con_threshold" => "Consensus line thresholds (in range 50..100) (separated by commas) (-con_threshold)",
	"con_ignore" => "Ignore singleton or class group (-con_ignore)",
	"hybrid_alignment_consensus_options" => "Hybrid alignment and consensus options",
	"con_gaps" => "Count gaps during consensus computations (-con_gaps)",
	"general_row_column_filters" => "General row/column filters",
	"top" => "Report top N hits (-top)",
	"range" => "Display column range M..N as numbered by ruler (M,N) (-range)",
	"maxident" => "Only report sequences with %identity <= N (-maxident)",
	"ref" => "Use row N or row identifier as %id entity reference (-ref)",
	"keep_only" => "Keep only the rows from start to end (separated by commas: start,end) (-keep)",
	"disc" => "Discard rows from start to end (separated by commas: start,end) (-disc)",
	"nops" => "Display rows unprocessed (separated by commas) (-nops)",
	"general_formatting_options" => "General formatting options",
	"width" => "Paginate in N columns of alignment (-width)",
	"gap" => "Use this character as the gap (-gap)",
	"label0" => "Switch off label: row number (-label0)",
	"label1" => "Switch off label: identifier (-label1)",
	"label2" => "Switch off label: description (-label2)",
	"label3" => "Switch off label: scores (-label3)",
	"label4" => "Switch off label: percent identity (-label4)",
	"html_markup_options" => "HTML markup options",
	"html_output" => "HTML output",
	"pagecolor" => "Page backgound color (-pagecolor)",
	"textcolor" => "Page text color (-textcolor)",
	"linkcolor" => "Link color (-linkcolor)",
	"alinkcolor" => "Active link color (-alinkcolor)",
	"vlinkcolor" => "Visited link color (-vlinkcolor)",
	"alncolor" => "Alignment background color (-alncolor)",
	"symcolor" => "Alignment default text color (-symcolor)",
	"gapcolor" => "Alignment gap color (-gapcolor)",
	"bold" => "Use bold emphasis for coloured residues (-bold)",
	"css" => "Use Cascading Style Sheets (-css)",
	"html_output_file" => "",
	"html_file" => "",
	"alig_file" => "",
	"out" => "Output format (-out)",

    };

    $self->{ISSTANDOUT}  = {
	"mview_alig" => 0,
	"alig" => 0,
	"in" => 0,
	"from_phylip" => 0,
	"main_formatting_options" => 0,
	"ruler" => 0,
	"alignment" => 0,
	"consensus" => 0,
	"dna" => 0,
	"alignment_options" => 0,
	"coloring" => 0,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 0,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 1,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 0,

    };

    $self->{VLIST}  = {

	"in" => ['pearson','Pearson/FASTA','msf','MSF (GCG)','clustal','CLUSTAL W','phylip','PHYLIP','hssp','MaxHom/HSSP','plain','plain','multas','multas: MULTAS/MULTAL ','mips','mips: MIPS-ALN',],
	"main_formatting_options" => ['ruler','alignment','consensus','dna',],
	"alignment_options" => ['coloring','threshold','ignore',],
	"coloring" => ['any','any: colour all the residues','consensus','consensus: colour only when above a given percent similarity','group','groups: colours residues by the colour of the class to which they belong','identity','identity: colouring by identity to the first sequence','none','none: no colouring',],
	"ignore" => ['class','class','none','none','singleton','singleton',],
	"consensus_options" => ['con_coloring','con_threshold','con_ignore',],
	"con_coloring" => ['any','any: colour all the residues','identity','identity: colouring by identity to the first sequence','none','none: no colouring',],
	"con_ignore" => ['class','class','none','none','singleton','singleton',],
	"hybrid_alignment_consensus_options" => ['con_gaps',],
	"general_row_column_filters" => ['top','range','maxident','ref','keep_only','disc','nops',],
	"general_formatting_options" => ['width','gap','label0','label1','label2','label3','label4',],
	"html_markup_options" => ['html_output','pagecolor','textcolor','linkcolor','alinkcolor','vlinkcolor','alncolor','symcolor','gapcolor','bold','css',],
	"html_output" => ['full','full','head','head','body','body','data','data','css','css','off','off',],
	"css" => ['off','off','on','on',],
	"out" => ['html','HTML','msf','GCG/MSF','pearson','Pearson/FASTA','pir','PIR','rdb','RDB table for storage/manipulation in relational database form',],
    };

    $self->{FLIST}  = {

    };

    $self->{SEPARATOR}  = {

    };

    $self->{VDEF}  = {
	"in" => 'clustal',
	"alignment" => '1',
	"dna" => '0',
	"threshold" => '70.0',
	"ignore" => 'none',
	"con_threshold" => '100,90,80,70',
	"con_ignore" => 'none',
	"con_gaps" => '1',
	"maxident" => '100',
	"html_output" => 'full',
	"textcolor" => 'black',
	"linkcolor" => 'blue',
	"alinkcolor" => 'red',
	"vlinkcolor" => 'purple',
	"css" => 'off',
	"out" => 'html',

    };

    $self->{PRECOND}  = {
	"mview_alig" => { "perl" => '1' },
	"alig" => { "perl" => '1' },
	"in" => { "perl" => '1' },
	"from_phylip" => {
		"perl" => '$in eq "phylip" ',
	},
	"main_formatting_options" => { "perl" => '1' },
	"ruler" => { "perl" => '1' },
	"alignment" => { "perl" => '1' },
	"consensus" => { "perl" => '1' },
	"dna" => { "perl" => '1' },
	"alignment_options" => { "perl" => '1' },
	"coloring" => { "perl" => '1' },
	"threshold" => { "perl" => '1' },
	"ignore" => { "perl" => '1' },
	"consensus_options" => {
		"perl" => '$consensus',
	},
	"con_coloring" => {
		"perl" => '$consensus',
	},
	"con_threshold" => {
		"perl" => '$consensus',
	},
	"con_ignore" => {
		"perl" => '$consensus',
	},
	"hybrid_alignment_consensus_options" => { "perl" => '1' },
	"con_gaps" => { "perl" => '1' },
	"general_row_column_filters" => { "perl" => '1' },
	"top" => { "perl" => '1' },
	"range" => { "perl" => '1' },
	"maxident" => { "perl" => '1' },
	"ref" => { "perl" => '1' },
	"keep_only" => { "perl" => '1' },
	"disc" => { "perl" => '1' },
	"nops" => { "perl" => '1' },
	"general_formatting_options" => { "perl" => '1' },
	"width" => { "perl" => '1' },
	"gap" => { "perl" => '1' },
	"label0" => { "perl" => '1' },
	"label1" => { "perl" => '1' },
	"label2" => { "perl" => '1' },
	"label3" => { "perl" => '1' },
	"label4" => { "perl" => '1' },
	"html_markup_options" => { "perl" => '1' },
	"html_output" => {
		"perl" => '$_html && $out eq "html" ',
	},
	"pagecolor" => { "perl" => '1' },
	"textcolor" => { "perl" => '1' },
	"linkcolor" => { "perl" => '1' },
	"alinkcolor" => { "perl" => '1' },
	"vlinkcolor" => { "perl" => '1' },
	"alncolor" => { "perl" => '1' },
	"symcolor" => { "perl" => '1' },
	"gapcolor" => { "perl" => '1' },
	"bold" => { "perl" => '1' },
	"css" => { "perl" => '1' },
	"html_output_file" => {
		"perl" => '$_html && $out eq "html" ',
	},
	"html_file" => {
		"perl" => '$_html && $out eq "html" ',
	},
	"alig_file" => {
		"perl" => '$out eq "msf" || $out eq "pearson" || $out eq "pir"',
	},
	"out" => { "perl" => '1' },

    };

    $self->{CTRL}  = {

    };

    $self->{PIPEOUT}  = {
	"alig_file" => {
		 '1' => "readseq_ok_alig",
	},

    };

    $self->{WITHPIPEOUT}  = {

    };

    $self->{PIPEIN}  = {
	"alig" => {
		 "readseq_ok_alig" => '1',
	},

    };

    $self->{WITHPIPEIN}  = {

    };

    $self->{ISCLEAN}  = {
	"mview_alig" => 0,
	"alig" => 0,
	"in" => 0,
	"from_phylip" => 0,
	"main_formatting_options" => 0,
	"ruler" => 0,
	"alignment" => 0,
	"consensus" => 0,
	"dna" => 0,
	"alignment_options" => 0,
	"coloring" => 0,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 0,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 0,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 0,

    };

    $self->{ISSIMPLE}  = {
	"mview_alig" => 0,
	"alig" => 1,
	"in" => 1,
	"from_phylip" => 0,
	"main_formatting_options" => 0,
	"ruler" => 1,
	"alignment" => 1,
	"consensus" => 1,
	"dna" => 1,
	"alignment_options" => 0,
	"coloring" => 1,
	"threshold" => 0,
	"ignore" => 0,
	"consensus_options" => 0,
	"con_coloring" => 0,
	"con_threshold" => 0,
	"con_ignore" => 0,
	"hybrid_alignment_consensus_options" => 0,
	"con_gaps" => 0,
	"general_row_column_filters" => 0,
	"top" => 0,
	"range" => 0,
	"maxident" => 0,
	"ref" => 0,
	"keep_only" => 0,
	"disc" => 0,
	"nops" => 0,
	"general_formatting_options" => 0,
	"width" => 0,
	"gap" => 0,
	"label0" => 0,
	"label1" => 0,
	"label2" => 0,
	"label3" => 0,
	"label4" => 0,
	"html_markup_options" => 0,
	"html_output" => 0,
	"pagecolor" => 0,
	"textcolor" => 0,
	"linkcolor" => 0,
	"alinkcolor" => 0,
	"vlinkcolor" => 0,
	"alncolor" => 0,
	"symcolor" => 0,
	"gapcolor" => 0,
	"bold" => 0,
	"css" => 0,
	"html_output_file" => 0,
	"html_file" => 0,
	"alig_file" => 0,
	"out" => 1,

    };

    $self->{PARAMFILE}  = {

    };

    $self->{COMMENT}  = {
	"coloring" => [
		"-coloring consensus: will colour only those residues that belong to a specified physicochemical class that is conserved in at least a specified percentage of all rows for a given column. This defaults to 70% and and may be set to another threshold, eg., -coloring consensus -threshold 80 would specify 80%. Note that the physicochemical classes in question can be confined to individual residues. ",
		"-coloring group, is like -coloring consensus, but colours residues by the colour of the class to which they belong.",
		"By default, the consensus computation counts gap characters, so that sections of the alignment may be uncolored where the presence of gaps prevents the non-gap count from reaching the threshold. Setting -con_gaps off prevents this, allowing sequence-only based consensus thresholding. ",
		"The default palette assumes the input alignment is of protein sequences and sets their colours according to amino acid physicochemical properties: another palette should be selected for DNA or RNA alignments. ",
		"Consensus colouring is complicated and some understanding of palettes and consensus patterns is required first before trying to explain alignment consensus colouring.",
	],
	"ignore" => [
		"Tip: If you want to see only the conserved residues above the threshold (ie., only one type of conserved residue per column), add the option -ignore class. ",
	],
	"con_coloring" => [
		"-coloring consensus: will colour only those residues that belong to a specified physicochemical class that is conserved in at least a specified percentage of all rows for a given column. This defaults to 70% and and may be set to another threshold, eg., -coloring consensus -threshold 80 would specify 80%. Note that the physicochemical classes in question can be confined to individual residues. ",
		"-coloring group, is like -coloring consensus, but colours residues by the colour of the class to which they belong.",
		"By default, the consensus computation counts gap characters, so that sections of the alignment may be uncolored where the presence of gaps prevents the non-gap count from reaching the threshold. Setting -con_gaps off prevents this, allowing sequence-only based consensus thresholding. ",
		"The default palette assumes the input alignment is of protein sequences and sets their colours according to amino acid physicochemical properties: another palette should be selected for DNA or RNA alignments. ",
		"Consensus colouring is complicated and some understanding of palettes and consensus patterns is required first before trying to explain alignment consensus colouring.",
	],

    };

    $self->{SCALEMIN}  = {

    };

    $self->{SCALEMAX}  = {

    };

    $self->{SCALEINC}  = {

    };

    $self->{INFO}  = {

    };

# -- end of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/mview_alig.pm



    $self->_init_params(@params);

    return $self;
}



1; # Needed to keep compiler happy

