# ipcress.pm,v 1.4 2005/09/27 14:10:59 jason Exp
#
# BioPerl module for Bio::Tools::ipcress
#
# Cared for by Sheldon McKay <mckays@cshl.edu>
#
# Copyright Sheldon McKay
#
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

Bio::Tools::ipcress - Parse ipcress output and make features

=head1 SYNOPSIS

    # A simple annotation pipeline wrapper for ipcress data
    # assuming ipcress data is already generated in file seq1.ipcress
    # and sequence data is in fasta format in file called seq1.fa

    use Bio::Tools::ipcress;
    use Bio::SeqIO;
    my $parser = new Bio::Tools::ipcress(-file => 'seq1.ipcress');
    my $seqio = new Bio::SeqIO(-format => 'fasta', -file => 'seq1.fa');
    my $seq = $seqio->next_seq || die("cannot get a seq object from SeqIO");

    while( my $feat = $parser->next_feature ) {
	# add ipcress annotation to a sequence
	$seq->add_SeqFeature($feat);
    }
    my $seqout = new Bio::SeqIO(-format => 'embl');
    $seqout->write_seq($seq);


=head1 DESCRIPTION

This object serves as a parser for ipcress data, creating a
Bio::SeqFeatureI for each ipcress hit.  These can be processed or added
as annotation to an existing Bio::SeqI object for the purposes of
automated annotation.

This module is adapted from the Bio::Tools::EPCR module
written by Jason Stajich (jason-at-bioperl.org).

Ipcress is available through Guy Slater's Exonerate package 
http://www.ebi.ac.uk/~guy/exonerate/

=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 the
web:

  http://bugzilla.bioperl.org/

=head1 AUTHOR - Sheldon McKay

Email mckays@cshl.edu

Describe contact details here

=head1 APPENDIX

The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _

=cut


# Let the code begin...


package Bio::Tools::ipcress;
use vars qw(@ISA);
use strict;

use Bio::Root::Root;
use Bio::SeqFeature::Generic;

@ISA = qw(Bio::Root::Root);

=head2 new

 Title   : new
 Usage   : my $ipcress = new Bio::Tools::ipcress(-file => $file,
					   -primary => $fprimary, 
					   -source => $fsource, 
					   -groupclass => $fgroupclass);
 Function: Initializes a new ipcress parser
 Returns : Bio::Tools::ipcress
 Args    : -fh   => filehandle
           OR
           -file => filename

           -primary => a string to be used as the common value for
                       each features '-primary' tag.  Defaults to
                       the sequence ontology term 'PCR_product'.
                       (This in turn maps to the GFF 'type'
                       tag (aka 'method')).

            -source => a string to be used as the common value for
                       each features '-source' tag.  Defaults to
                       'ipcress'. (This in turn maps to the GFF 'source'
                       tag)

             -groupclass => a string to be used as the name of the tag
                           which will hold the sts marker namefirst
                           attribute.  Defaults to 'name'.

=cut

sub new {
  my($class,@args) = @_;

  my $self = $class->SUPER::new(@args);
  my ($primary, $source, 
      $groupclass, $file, $fh) = $self->_rearrange([qw(PRIMARY
						       SOURCE 
						       GROUPCLASS
						       FILE FH)],@args);
  $self->primary(defined $primary ? $primary : 'PCR_product');
  $self->source(defined $source ? $source : 'ipcress');
  $self->groupclass(defined $groupclass ? $groupclass : 'name');

  local $/ = 'Ipcress result';
  my @result;

  if ($file) {
      open FH, $file;
      @result = (<FH>);
      close FH;
  }
  elsif ($fh) {
      @result = (<$fh>);
  }
  else {
      $self->throw("Bio::Tools::ipcress: no input file");
  }


  shift @result;

  $self->{result} = \@result;

  return $self;
}

=head2 next_feature

 Title   : next_feature
 Usage   : $seqfeature = $obj->next_feature();
 Function: Returns the next feature available in the analysis result, or
           undef if there are no more features.
 Example :
 Returns : A Bio::SeqFeatureI implementing object, or undef if there are no
           more features.
 Args    : none    

=cut

sub next_feature {
    my ($self) = @_;
    my $result = shift @{$self->{result}};
    return undef unless defined($result);

    chomp $result;
    my @lines = split "\n", $result;
    my ($ipcress) = grep /ipcress: /, @lines;

    my (undef,$seqname,$mkrname,$length,undef,$start,$mismatchL,
       undef,undef,$mismatchR,$desc) = split /\s+/, $ipcress;
 
    my $end = $start + $length;
    $start += 1;

    my $strand = $desc eq 'forward' ? '+' : $desc eq 'revcomp' ? '-' : 0;
    
    my ($left)  = grep /\# forward/, @lines;
    $left  =~ s/[^A-Z]+//g;
    my ($right) = grep /\# revcomp/, @lines;
    $right =~ s/[^A-Z]+//g;
    $right = reverse $right;

    # if there are multiple hits, increment the name for
    # the groupclass
    if (++$self->{seen}->{$mkrname} > 1) {
        $mkrname .= "\.$self->{seen}->{$mkrname}";
    }


    my $markerfeature = new Bio::SeqFeature::Generic 
	( '-start'   => $start,
	  '-end'     => $end,
	  '-strand'  => $strand,
	  '-source'  => $self->source,
	  '-primary' => $self->primary,
	  '-seq_id'  => $seqname,
	  '-tag'     => {
	      $self->groupclass => $mkrname,
	  });

    if (!$strand) {
	$markerfeature->add_tag_value('Note' => "bad product: single primer amplification");
    }

    $markerfeature->add_tag_value('left_primer' => $left);
    $markerfeature->add_tag_value('right_primer' => $right);
    $markerfeature->add_tag_value('left_mismatches' => $mismatchL) if $mismatchL;
    $markerfeature->add_tag_value('right_mismatches' => $mismatchR) if $mismatchR;

    return $markerfeature;
}

=head2 source

 Title   : source
 Usage   : $obj->source($newval)
 Function: 
 Example : 
 Returns : value of source (a scalar)
 Args    : on set, new value (a scalar or undef, optional)


=cut

sub source{
    my $self = shift;
    return $self->{'_source'} = shift if @_;
    return $self->{'_source'};
}

=head2 primary

 Title   : primary
 Usage   : $obj->primary($newval)
 Function: 
 Example : 
 Returns : value of primary (a scalar)
 Args    : on set, new value (a scalar or undef, optional)


=cut

sub primary{
    my $self = shift;
    return $self->{'_primary'} = shift if @_;
    return $self->{'_primary'};
}

=head2 groupclass

 Title   : groupclass
 Usage   : $obj->groupclass($newval)
 Function: 
 Example : 
 Returns : value of groupclass (a scalar)
 Args    : on set, new value (a scalar or undef, optional)


=cut

sub groupclass{
    my $self = shift;

    return $self->{'_groupclass'} = shift if @_;
    return $self->{'_groupclass'};
}

1;
