bp_bin/write_blast

   1 #!/usr/bin/env perl
   2
   3 # Copyright (C) 2007-2009 Martin A. Hansen.
   4
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18
  19 # http://www.gnu.org/copyleft/gpl.html
  20
  21
  22 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> DESCRIPTION <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  23
  24 # Write tabular BLAST output from the stream.
  25
  26 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  27
  28
  29 use warnings;
  30 use strict;
  31 use Maasha::Fasta;
  32 use Maasha::Biopieces;
  33
  34
  35 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  36
  37
  38 my ( $options, $in, $out, $record, $first, $entry, $data_out );
  39
  40 $options = Maasha::Biopieces::parse_options(
  41     [
  42         { long => 'no_stream', short => 'x', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  43         { long => 'data_out',  short => 'o', type => 'file', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  44         { long => 'comment',   short => 'c', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  45         { long => 'compress',  short => 'Z', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  46     ]
  47 );
  48
  49 $in       = Maasha::Biopieces::read_stream( $options->{ "stream_in" } );
  50 $out      = Maasha::Biopieces::write_stream( $options->{ "stream_out" } );
  51 $data_out = Maasha::Biopieces::write_stream( $options->{ "data_out" }, $options->{ "compress" } ) ;
  52
  53 $first = 1;
  54
  55 while ( $record = Maasha::Biopieces::get_record( $in ) )
  56 {
  57     if ( $entry = biopiece2blast_tab( $record ) )
  58     {
  59         if ( $options->{ "comment" } and $first )
  60         {
  61             print $data_out "# Fields: Query id, Subject id, % identity, alignment length, mismatches, gap openings, q. start, q. end, s. start, s. end, e-value, bit score\n";
  62
  63             $first = 0;
  64         }
  65
  66         print $data_out join( "\t", @{ $entry } ), "\n";
  67     }
  68
  69     Maasha::Biopieces::put_record( $record, $out ) if not $options->{ "no_stream" };
  70 }
  71
  72 close $data_out;
  73
  74 Maasha::Biopieces::close_stream( $in );
  75 Maasha::Biopieces::close_stream( $out );
  76
  77
  78 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> SUBROUTINES <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  79
  80
  81 sub biopiece2blast_tab
  82 {
  83     # Martin A. Hansen, May 2009.
  84
  85     # Convert a Biopiece record to a BLAST tabular entry.
  86     # Note that we correct positions because BLAST is 1-based.
  87
  88     my ( $record,   # hashref
  89        ) = @_;
  90
  91     # Returns a list.
  92
  93     my ( @fields, $s_beg, $s_end );
  94
  95     return undef if not defined $record->{ 'REC_TYPE' } or not $record->{ 'REC_TYPE' } eq "BLAST";
  96
  97     if ( $record->{ "STRAND" } eq '+' )
  98     {
  99         $s_beg = $record->{ "S_BEG" };
 100         $s_end = $record->{ "S_END" };
 101     }
 102     else
 103     {
 104         $s_beg = $record->{ "S_END" };
 105         $s_end = $record->{ "S_BEG" };
 106     }
 107
 108     $fields[ 0 ]  = $record->{ "Q_ID" };
 109     $fields[ 1 ]  = $record->{ "S_ID" };
 110     $fields[ 2 ]  = $record->{ "IDENT" };
 111     $fields[ 3 ]  = $record->{ "ALIGN_LEN" };
 112     $fields[ 4 ]  = $record->{ "MISMATCHES" };
 113     $fields[ 5 ]  = $record->{ "GAPS" };
 114     $fields[ 6 ]  = $record->{ "Q_BEG" } + 1;
 115     $fields[ 7 ]  = $record->{ "Q_END" } + 1;
 116     $fields[ 8 ]  = $s_beg + 1;
 117     $fields[ 9 ]  = $s_end + 1;
 118     $fields[ 10 ] = $record->{ "E_VAL" };
 119     $fields[ 11 ] = $record->{ "BIT_SCORE" };
 120
 121     return wantarray ? @fields : \@fields;
 122 }
 123
 124
 125 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 126
 127
 128 BEGIN
 129 {
 130     Maasha::Biopieces::status_set();
 131 }
 132
 133
 134 END
 135 {
 136     Maasha::Biopieces::status_log();
 137 }
 138
 139
 140 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 141
 142
 143 __END__