bin/parse_harvester_results

   1 #! /usr/bin/perl
   2
   3 # parse_harvester_results retreives files of search results from ncbi,
   4 # and is released under the terms of the GPL version 2, or any later
   5 # version, at your option. See the file README and COPYING for more
   6 # information.
   7
   8 # Copyright 2004 by Don Armstrong <don@donarmstrong.com>.
   9
  10 # $Id: ss,v 1.1 2004/06/29 05:26:35 don Exp $
  11
  12
  13 use warnings;
  14 use strict;
  15
  16
  17 use Getopt::Long;
  18 use Pod::Usage;
  19
  20 =head1 NAME
  21
  22   parse_harvester_results [options]
  23
  24 =head1 SYNOPSIS
  25
  26
  27  Options:
  28   --dir, -D directory to stick results into [default .]
  29   --name, -n file naming scheme [default ${search}_results.$format]
  30   --terms, -t file of search terms [default -]
  31   --debug, -d debugging level [default 0]
  32   --help, -h display this help
  33   --man, -m display manual
  34
  35 =head1 OPTIONS
  36
  37 =over
  38
  39 =item B<--debug, -d>
  40
  41 Debug verbosity. (Default 0)
  42
  43 =item B<--help, -h>
  44
  45 Display brief useage information.
  46
  47 =item B<--man, -m>
  48
  49 Display this manual.
  50
  51 =back
  52
  53 =head1 EXAMPLES
  54
  55   parse_harvester_results -D ./harvester_results/ -n '${search}_name.html' < search_parameters
  56
  57 Will pretty much do what you want
  58
  59 =cut
  60
  61
  62
  63 use vars qw($DEBUG $REVISION);
  64
  65 BEGIN{
  66      ($REVISION) = q$LastChangedRevision: 1$ =~ /LastChangedRevision:\s+([^\s]+)/;
  67      $DEBUG = 0 unless defined $DEBUG;
  68 }
  69
  70 use IO::File;
  71 use IO::Dir;
  72
  73 # XXX parse config file
  74
  75 my %options = (debug    => 0,
  76                help     => 0,
  77                man      => 0,
  78                dir      => '.',
  79                keyword  => undef,
  80                keywords => 0,
  81               );
  82
  83 GetOptions(\%options,'keyword|k=s','dir|D=s','debug|d+','help|h|?','man|m');
  84
  85
  86 pod2usage() if $options{help};
  87 pod2usage({verbose=>2}) if $options{man};
  88
  89 $DEBUG = $options{debug};
  90
  91 # CSV columns
  92 use constant {NAME        => 0,
  93               REFSEQ      => 1,
  94               LOCATION    => 2,
  95               ALIAS       => 3,
  96               FUNCTION    => 4,
  97               DESCRIPTION => 5,
  98               KEYWORD     => 6,
  99               DBNAME      => 7,
 100               FILENAME    => 8,
 101              };
 102
 103 if ($options{keywords}) {
 104      if (@ARGV != 1) {
 105           pod2usage("If the --keywords option is used, exactly one argument (the keyword) must be passed");
 106      }
 107      $option{dir} = "$ARGV[0]_results_harvester";
 108 }
 109
 110
 111
 112 if (not -d $options{dir}) {
 113      die "$options{dir} does not exist or is not a directory";
 114 }
 115
 116 my $dir = new IO::Dir $options{dir} or die "Unable to open dir $options{dir}: $!";
 117
 118 print join(",", map {qq("$_");} qw(Name RefSeq Location Alias Function Description Keyword DBName Filename)),qq(\n);
 119
 120 my ($keyword) = $options{keyword} || $options{dir} =~ m#(?:^|/)([^\/]+)_results_harvester#;
 121
 122 while ($_ = $dir->read) {
 123      my $file_name = $_;
 124      next if $file_name =~ /^\./;
 125      next unless -f "$options{dir}/$file_name" and -r "$options{dir}/$file_name";
 126
 127      my $file = new IO::File "$options{dir}/$file_name", 'r' or die "Unable to open file $file_name";
 128
 129      local $/;
 130      my $result = <$file>;
 131
 132      my @results;
 133
 134      # Find gene name
 135      ($results[NAME]) = $result =~ m&<img\s+src=\"http://genome-www5.stanford.edu/images/SOURCE/hsgr.gif\"\s*/>
 136                                      </td><td\s+bgcolor="tomato"\s+colspan="1"><center><font\s+size="\+5"
 137                                      \s+color="white">([^<]+)</font></center>&xis;
 138
 139      if (not defined $results[NAME]) {
 140           ($results[NAME]) = $result =~ m&<TR>\s*<TD\s*BGCOLOR="\#FEFE99"\s*VALIGN="top"\s*NOWRAP>Entry\s*name</TD>\s*
 141                                           <TD\s*VALIGN="top"\s*COLSPAN="5">\s*<b>\s*([^<]+?)\s*</b></TD>\s*</TR>&xis;
 142      }
 143
 144      $results[NAME] ||= 'NO NAME';
 145
 146      # Find REF SEQ number
 147      ($results[REFSEQ]) = $result =~ m&<a\s+href="http://www.ncbi.nlm.nih.gov/entrez/
 148                                        query.fcgi\?db=Nucleotide\&amp;cmd=Search\&amp;term=([^\&]+)\&amp;doptcmdl=GenBank">&xis;
 149
 150      $results[REFSEQ] ||= 'NO REFSEQ';
 151
 152      # Find Chromosomal Location
 153      ($results[LOCATION]) = $result =~ m&Chromosomal\s+Location</font></td></tr>\s+<tr><td\s+colspan="1"\s+bgcolor="beige"><dl>
 154                                          <dd><b>Chromosome/Cytoband</b></td><td\s+width="525"><center>\s*([^\<]+?)\s*</center>&xis;
 155
 156      $results[LOCATION] ||= 'NO LOCATION';
 157      # Find gene aliases
 158      # SOURCE ALIASES
 159      my ($alias_table) = $result =~ m|Aliases</font></td></tr>\s*<tr><td\s+bgcolor=\"beige\"\s+colspan=\"2\">
 160                                       <font\s+size=\"-1\"\s*/>\s+<ul>(.+?)</ul>|xis;
 161      $alias_table ||='';
 162
 163      my @gene_aliases = $alias_table =~ m&<li>\s*([^\(\<]{0,30}?)\s*(?:\<|\()&gis;
 164
 165      # UNIPROT ALIASES
 166      push @gene_aliases, $result =~ m&<TR>\s*<TD\s+BGCOLOR=\"\#CECFCE\"\s+VALIGN=\"top\"\s+NOWRAP>\s*Synonym\(s\)\s*</TD>\s*
 167                                       <TD\s+VALIGN=\"top\"\s+COLSPAN=\"\d\">\s*([^<]+?)\s*</TD>\s*</TR>&xis;
 168      push @gene_aliases, $result =~ m&<TD\s+BGCOLOR=\"\#CECFCE\"\s+VALIGN=\"top\"\s*>\s*Description\s*</TD>\s*
 169                                       <TD\s+VALIGN=\"top\"\s+COLSPAN=\"\d\">\s*([^<]+?)\s*</TD>\s*</TR>&xis;
 170
 171      $results[ALIAS] = join('; ', @gene_aliases);
 172      $results[ALIAS] ||= 'NO ALIASES';
 173
 174      # Find gene function(s)
 175
 176      # Stanford GO functions
 177      my ($gene_ontology) = $result =~ m&<table\s+width="100%"\s+cellspacing="0"\s+border="1"><tr>\s*
 178                                         <th\s+valign="middle"\s+align="left"\s+bgcolor="\#CCCCCC">Ontology</th>\s*(.+?)</table>&xis;
 179
 180      my @functions;
 181      push @functions, map {s#\s*\"\>\s*# #g; $_;} $gene_ontology =~ m&<a\s+href="http://godatabase.org/cgi-bin/go.cgi\?view=details
 182                                                                       \&amp;depth=1\&amp;query=([^\"]+\">[^\<]+)</a>&gxis
 183                                                                            if defined $gene_ontology;
 184
 185      # UNIPROT GO Functions
 186      push @functions, map {s#\s*</a>\;?\s*# #g; $_;} m&<TD\s+VALIGN="top"\s+COLSPAN="5">
 187                                                     <a\s+href="http://www.ebi.ac.uk/ego/GSearch\?query=[^\&+]\&mode=id">
 188                                                     (GO\:\d+</a>\;\s+[^\<]+?)\s*</TD>&xgis;
 189
 190      $results[FUNCTION] = join('; ', map {(defined $_)?($_):()} @functions);
 191      $results[FUNCTION] ||= 'NO FUNCTION';
 192
 193      # Figure out the keyword used
 194      $results[KEYWORD] = $keyword;
 195
 196      $results[KEYWORD] ||= 'NO KEYWORD';
 197
 198      # Figure out what the description is
 199      ($results[DESCRIPTION]) = map{s#\n# #g; $_;} $result =~ m&<b>Locus\s+Link\s+Summary</b></td><td\s+width="\d+">(.+?)\s*</td>\s*</tr>&is;
 200      if (not defined $results[DESCRIPTION]) {
 201           ($results[DESCRIPTION]) = map{s#\n# #g; $_;} $result =~ m&<TD\s+BGCOLOR="\#CECFCE"\s+VALIGN="center"\s+COLSPAN="2">
 202                                                                     <FONT\s+face="verdana,helvetica,arial,sans-serif"><B>FUNCTION</B></TD>\s*
 203                                                                     <TD\s+VALIGN="top"\s+COLSPAN="4">([^\<]+)</TD>\s*</TR>&xis;
 204      }
 205      $results[DESCRIPTION] ||= '';
 206
 207      # Database searched
 208      $results[DBNAME] = 'harvester';
 209      $results[FILENAME] = $file_name;
 210
 211      print join(',',map {qq("$_")} @results),qq(\n);
 212 }
 213
 214
 215
 216
 217
 218
 219 __END__