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 strict;
  30 use Maasha::Fasta;
  31 use Maasha::Biopieces;
  32
  33
  34 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  35
  36
  37 my ( $options, $in, $out, $record, $first, $entry, $data_out );
  38
  39 $options = Maasha::Biopieces::parse_options(
  40     [
  41         { long => 'no_stream', short => 'x', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  42         { long => 'data_out',  short => 'o', type => 'file', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  43         { long => 'comment',   short => 'c', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  44         { long => 'compress',  short => 'Z', type => 'flag', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
  45     ]
  46 );
  47
  48 $in       = Maasha::Biopieces::read_stream( $options->{ "stream_in" } );
  49 $out      = Maasha::Biopieces::write_stream( $options->{ "stream_out" } );
  50 $data_out = Maasha::Biopieces::write_stream( $options->{ "data_out" }, $options->{ "compress" } ) ;
  51
  52 $first = 1;
  53
  54 while ( $record = Maasha::Biopieces::get_record( $in ) )
  55 {
  56     if ( $entry = biopiece2blast_tab( $record ) )
  57     {
  58         if ( $options->{ "comment" } and $first )
  59         {
  60             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";
  61
  62             $first = 0;
  63         }
  64
  65         print $data_out join( "\t", @{ $entry } ), "\n";
  66     }
  67
  68     Maasha::Biopieces::put_record( $record, $out ) if not $options->{ "no_stream" };
  69 }
  70
  71 close $data_out;
  72
  73 Maasha::Biopieces::close_stream( $in );
  74 Maasha::Biopieces::close_stream( $out );
  75
  76
  77 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> SUBROUTINES <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  78
  79
  80 sub biopiece2blast_tab
  81 {
  82     # Martin A. Hansen, May 2009.
  83
  84     # Convert a Biopiece record to a BLAST tabular entry.
  85     # Note that we correct positions because BLAST is 1-based.
  86
  87     my ( $record,   # hashref
  88        ) = @_;
  89
  90     # Returns a list.
  91
  92     my ( @fields, $s_beg, $s_end );
  93
  94     return undef if not defined $record->{ 'REC_TYPE' } or not $record->{ 'REC_TYPE' } eq "BLAST";
  95
  96     if ( $record->{ "STRAND" } eq '+' )
  97     {
  98         $s_beg = $record->{ "S_BEG" };
  99         $s_end = $record->{ "S_END" };
 100     }
 101     else
 102     {
 103         $s_beg = $record->{ "S_END" };
 104         $s_end = $record->{ "S_BEG" };
 105     }
 106
 107     $fields[ 0 ]  = $record->{ "Q_ID" };
 108     $fields[ 1 ]  = $record->{ "S_ID" };
 109     $fields[ 2 ]  = $record->{ "IDENT" };
 110     $fields[ 3 ]  = $record->{ "ALIGN_LEN" };
 111     $fields[ 4 ]  = $record->{ "MISMATCHES" };
 112     $fields[ 5 ]  = $record->{ "GAPS" };
 113     $fields[ 6 ]  = $record->{ "Q_BEG" } + 1;
 114     $fields[ 7 ]  = $record->{ "Q_END" } + 1;
 115     $fields[ 8 ]  = $s_beg + 1;
 116     $fields[ 9 ]  = $s_end + 1;
 117     $fields[ 10 ] = $record->{ "E_VAL" };
 118     $fields[ 11 ] = $record->{ "BIT_SCORE" };
 119
 120     return wantarray ? @fields : \@fields;
 121 }
 122
 123
 124 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 125
 126
 127 BEGIN
 128 {
 129     Maasha::Biopieces::status_set();
 130 }
 131
 132
 133 END
 134 {
 135     Maasha::Biopieces::status_log();
 136 }
 137
 138
 139 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 140
 141
 142 __END__