—
—

              
# $Id: nthseq.pm,v 1.6 2006/07/04 22:23:35 mauricio Exp $
# BioPerl module for Bio::Tools::Run::PiseApplication::nthseq
#
# Cared for by Catherine Letondal <letondal@pasteur.fr>
#
# For copyright and disclaimer see below.
#
# POD documentation - main docs before the code
HideShow 103 lines of Pod
=head1 NAME
Bio::Tools::Run::PiseApplication::nthseq
=head1 SYNOPSIS
  #
=head1 DESCRIPTION
Bio::Tools::Run::PiseApplication::nthseq
      Bioperl class for:
        NTHSEQ  Writes one sequence from a multiple set of sequences (EMBOSS)
      Parameters: 
        (see also:
          http://bioweb.pasteur.fr/seqanal/interfaces/nthseq.html 
         for available values):
                nthseq (String)
                init (String)
                sequence (Sequence)
                        sequence [sequences] (-sequence)
                        pipe: seqsfile
                number (Integer)
                        The number of the sequence to output (-number)
                outseq (OutFile)
                        outseq (-outseq)
                        pipe: seqfile
                outseq_sformat (Excl)
                        Output format for: outseq
                auto (String)
=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/wiki/Mailing_lists  - 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 the
web:
  http://bugzilla.open-bio.org/
=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/nthseq.html
=item *
Bio::Tools::Run::PiseApplication
=item *
Bio::Tools::Run::AnalysisFactory::Pise
=item *
Bio::Tools::Run::PiseJob
=back
=cut
#'
package Bio::Tools::Run::PiseApplication::nthseq;
use vars qw(@ISA);
use strict;
use Bio::Tools::Run::PiseApplication;
@ISA = qw(Bio::Tools::Run::PiseApplication);
HideShow 14 lines of Pod
=head2 new
 Title   : new()
 Usage   : my $nthseq = Bio::Tools::Run::PiseApplication::nthseq->new($location, $email, @params);
 Function: Creates a Bio::Tools::Run::PiseApplication::nthseq 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 $nthseq = $factory->program('nthseq');
 Example : -
 Returns : An instance of Bio::Tools::Run::PiseApplication::nthseq.
=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/nthseq.pm
    $self->{COMMAND}   = "nthseq";
    $self->{VERSION}   = "5.a";
    $self->{TITLE}   = "NTHSEQ";
    $self->{DESCRIPTION}   = "Writes one sequence from a multiple set of sequences (EMBOSS)";
    $self->{OPT_EMAIL}   = 0;
    $self->{CATEGORIES}   =  [  
         "edit",
  ];
    $self->{DOCLINK}   = "http://www.uk.embnet.org/Software/EMBOSS/Apps/nthseq.html";
    $self->{_INTERFACE_STANDOUT} = undef;
    $self->{_STANDOUT_FILE} = undef;
    $self->{TOP_PARAMETERS}  = [ 
        "nthseq",
        "init",
        "input",
        "required",
        "output",
        "auto",
    ];
    $self->{PARAMETERS_ORDER}  = [
        "nthseq",
        "init",
        "input",        # input Section
        "sequence",     # sequence [sequences] (-sequence)
        "required",     # required Section
        "number",       # The number of the sequence to output (-number)
        "output",       # output Section
        "outseq",       # outseq (-outseq)
        "outseq_sformat",       # Output format for: outseq
        "auto",
    ];
    $self->{TYPE}  = {
        "nthseq" => 'String',
        "init" => 'String',
        "input" => 'Paragraph',
        "sequence" => 'Sequence',
        "required" => 'Paragraph',
        "number" => 'Integer',
        "output" => 'Paragraph',
        "outseq" => 'OutFile',
        "outseq_sformat" => 'Excl',
        "auto" => 'String',
    };
    $self->{FORMAT}  = {
        "init" => {
                "perl" => ' "" ',
        },
        "input" => {
        },
        "sequence" => {
                "perl" => '" -sequence=$value -sformat=fasta"',
        },
        "required" => {
        },
        "number" => {
                "perl" => '" -number=$value"',
        },
        "output" => {
        },
        "outseq" => {
                "perl" => '" -outseq=$value"',
        },
        "outseq_sformat" => {
                "perl" => '" -osformat=$value"',
        },
        "auto" => {
                "perl" => '" -auto -stdout"',
        },
        "nthseq" => {
                "perl" => '"nthseq"',
        }
    };
    $self->{FILENAMES}  = {
    };
    $self->{SEQFMT}  = {
        "sequence" => [8],
    };
    $self->{GROUP}  = {
        "init" => -10,
        "sequence" => 1,
        "number" => 2,
        "outseq" => 3,
        "outseq_sformat" => 4,
        "auto" => 5,
        "nthseq" => 0
    };
    $self->{BY_GROUP_PARAMETERS}  = [
        "init",
        "input",
        "nthseq",
        "required",
        "output",
        "sequence",
        "number",
        "outseq",
        "outseq_sformat",
        "auto",
    ];
    $self->{SIZE}  = {
    };
    $self->{ISHIDDEN}  = {
        "init" => 1,
        "input" => 0,
        "sequence" => 0,
        "required" => 0,
        "number" => 0,
        "output" => 0,
        "outseq" => 0,
        "outseq_sformat" => 0,
        "auto" => 1,
        "nthseq" => 1
    };
    $self->{ISCOMMAND}  = {
        "init" => 0,
        "input" => 0,
        "sequence" => 0,
        "required" => 0,
        "number" => 0,
        "output" => 0,
        "outseq" => 0,
        "outseq_sformat" => 0,
        "auto" => 0,
    };
    $self->{ISMANDATORY}  = {
        "init" => 0,
        "input" => 0,
        "sequence" => 1,
        "required" => 0,
        "number" => 1,
        "output" => 0,
        "outseq" => 1,
        "outseq_sformat" => 0,
        "auto" => 0,
    };
    $self->{PROMPT}  = {
        "init" => "",
        "input" => "input Section",
        "sequence" => "sequence [sequences] (-sequence)",
        "required" => "required Section",
        "number" => "The number of the sequence to output (-number)",
        "output" => "output Section",
        "outseq" => "outseq (-outseq)",
        "outseq_sformat" => "Output format for: outseq",
        "auto" => "",
    };
    $self->{ISSTANDOUT}  = {
        "init" => 0,
        "input" => 0,
        "sequence" => 0,
        "required" => 0,
        "number" => 0,
        "output" => 0,
        "outseq" => 0,
        "outseq_sformat" => 0,
        "auto" => 0,
    };
    $self->{VLIST}  = {
        "input" => ['sequence',],
        "required" => ['number',],
        "output" => ['outseq','outseq_sformat',],
        "outseq_sformat" => ['fasta','fasta','gcg','gcg','phylip','phylip','embl','embl','swiss','swiss','ncbi','ncbi','nbrf','nbrf','genbank','genbank','ig','ig','codata','codata','strider','strider','acedb','acedb','staden','staden','text','text','fitch','fitch','msf','msf','clustal','clustal','phylip','phylip','phylip3','phylip3','asn1','asn1',],
    };
    $self->{FLIST}  = {
    };
    $self->{SEPARATOR}  = {
    };
    $self->{VDEF}  = {
        "number" => '1',
        "outseq" => 'outseq.out',
        "outseq_sformat" => 'fasta',
    };
    $self->{PRECOND}  = {
        "init" => { "perl" => '1' },
        "input" => { "perl" => '1' },
        "sequence" => { "perl" => '1' },
        "required" => { "perl" => '1' },
        "number" => { "perl" => '1' },
        "output" => { "perl" => '1' },
        "outseq" => { "perl" => '1' },
        "outseq_sformat" => { "perl" => '1' },
        "auto" => { "perl" => '1' },
    };
    $self->{CTRL}  = {
    };
    $self->{PIPEOUT}  = {
        "outseq" => {
                 '1' => "seqfile",
        },
    };
    $self->{WITHPIPEOUT}  = {
    };
    $self->{PIPEIN}  = {
        "sequence" => {
                 "seqsfile" => '1',
        },
    };
    $self->{WITHPIPEIN}  = {
    };
    $self->{ISCLEAN}  = {
        "init" => 0,
        "input" => 0,
        "sequence" => 0,
        "required" => 0,
        "number" => 0,
        "output" => 0,
        "outseq" => 0,
        "outseq_sformat" => 0,
        "auto" => 0,
    };
    $self->{ISSIMPLE}  = {
        "init" => 0,
        "input" => 0,
        "sequence" => 1,
        "required" => 0,
        "number" => 1,
        "output" => 0,
        "outseq" => 1,
        "outseq_sformat" => 1,
        "auto" => 0,
    };
    $self->{PARAMFILE}  = {
    };
    $self->{COMMENT}  = {
    };
    $self->{SCALEMIN}  = {
    };
    $self->{SCALEMAX}  = {
    };
    $self->{SCALEINC}  = {
    };
    $self->{INFO}  = {
    };
# -- end of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/nthseq.pm
    $self->_init_params(@params);
    return $self;
}
1; # Needed to keep compiler happy