7a8cfd4a3ef37b40e7d63c36424d2e34c81ae59d
[function2gene.git] / 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            'keywords',
85           );
86
87
88 pod2usage() if $options{help};
89 pod2usage({verbose=>2}) if $options{man};
90
91 $DEBUG = $options{debug};
92
93 # CSV columns
94 use constant {NAME        => 0,
95               REFSEQ      => 1,
96               LOCATION    => 2,
97               ALIAS       => 3,
98               FUNCTION    => 4,
99               DESCRIPTION => 5,
100               KEYWORD     => 6,
101               DBNAME      => 7,
102               FILENAME    => 8,
103              };
104
105 if ($options{keywords}) {
106      if (@ARGV != 1) {
107           pod2usage("If the --keywords option is used, exactly one argument (the keyword) must be passed");
108      }
109      $options{dir} = "$ARGV[0]_results_harvester";
110 }
111
112
113
114 if (not -d $options{dir}) {
115      die "$options{dir} does not exist or is not a directory";
116 }
117
118 my $dir = new IO::Dir $options{dir} or die "Unable to open dir $options{dir}: $!";
119
120 print join(",", map {qq("$_");} qw(Name RefSeq Location Alias Function Description Keyword DBName Filename)),qq(\n);
121
122 my ($keyword) = $options{keyword} || $options{dir} =~ m#(?:^|/)([^\/]+)_results_harvester#;
123
124 while ($_ = $dir->read) {
125      my $file_name = $_;
126      next if $file_name =~ /^\./;
127      next unless -f "$options{dir}/$file_name" and -r "$options{dir}/$file_name";
128
129      my $file = new IO::File "$options{dir}/$file_name", 'r' or die "Unable to open file $file_name";
130
131      local $/;
132      my $result = <$file>;
133
134      my @results;
135
136      # Find gene name
137      ($results[NAME]) = $result =~ m&<img\s+src=\"http://genome-www5.stanford.edu/images/SOURCE/hsgr.gif\"\s*/>
138                                      </td><td\s+bgcolor="tomato"\s+colspan="1"><center><font\s+size="\+5"
139                                      \s+color="white">([^<]+)</font></center>&xis;
140
141      if (not defined $results[NAME]) {
142           ($results[NAME]) = $result =~ m&<TR>\s*<TD\s*BGCOLOR="\#FEFE99"\s*VALIGN="top"\s*NOWRAP>Entry\s*name</TD>\s*
143                                           <TD\s*VALIGN="top"\s*COLSPAN="5">\s*<b>\s*([^<]+?)\s*</b></TD>\s*</TR>&xis;
144      }
145
146      $results[NAME] ||= 'NO NAME';
147
148      # Find REF SEQ number
149      ($results[REFSEQ]) = $result =~ m&<a\s+href="http://www.ncbi.nlm.nih.gov/entrez/
150                                        query.fcgi\?db=Nucleotide\&amp;cmd=Search\&amp;term=([^\&]+)\&amp;doptcmdl=GenBank">&xis;
151
152      $results[REFSEQ] ||= 'NO REFSEQ';
153
154      # Find Chromosomal Location
155      ($results[LOCATION]) = $result =~ m&Chromosomal\s+Location</font></td></tr>\s+<tr><td\s+colspan="1"\s+bgcolor="beige"><dl>
156                                          <dd><b>Chromosome/Cytoband</b></td><td\s+width="525"><center>\s*([^\<]+?)\s*</center>&xis;
157
158      $results[LOCATION] ||= 'NO LOCATION';
159      # Find gene aliases
160      # SOURCE ALIASES
161      my ($alias_table) = $result =~ m|Aliases</font></td></tr>\s*<tr><td\s+bgcolor=\"beige\"\s+colspan=\"2\">
162                                       <font\s+size=\"-1\"\s*/>\s+<ul>(.+?)</ul>|xis;
163      $alias_table ||='';
164
165      my @gene_aliases = $alias_table =~ m&<li>\s*([^\(\<]{0,30}?)\s*(?:\<|\()&gis;
166
167      # UNIPROT ALIASES
168      push @gene_aliases, $result =~ m&<TR>\s*<TD\s+BGCOLOR=\"\#CECFCE\"\s+VALIGN=\"top\"\s+NOWRAP>\s*Synonym\(s\)\s*</TD>\s*
169                                       <TD\s+VALIGN=\"top\"\s+COLSPAN=\"\d\">\s*([^<]+?)\s*</TD>\s*</TR>&xis;
170      push @gene_aliases, $result =~ m&<TD\s+BGCOLOR=\"\#CECFCE\"\s+VALIGN=\"top\"\s*>\s*Description\s*</TD>\s*
171                                       <TD\s+VALIGN=\"top\"\s+COLSPAN=\"\d\">\s*([^<]+?)\s*</TD>\s*</TR>&xis;
172
173      $results[ALIAS] = join('; ', @gene_aliases);
174      $results[ALIAS] ||= 'NO ALIASES';
175
176      # Find gene function(s)
177
178      # Stanford GO functions
179      my ($gene_ontology) = $result =~ m&<table\s+width="100%"\s+cellspacing="0"\s+border="1"><tr>\s*
180                                         <th\s+valign="middle"\s+align="left"\s+bgcolor="\#CCCCCC">Ontology</th>\s*(.+?)</table>&xis;
181
182      my @functions;
183      push @functions, map {s#\s*\"\>\s*# #g; $_;} $gene_ontology =~ m&<a\s+href="http://godatabase.org/cgi-bin/go.cgi\?view=details
184                                                                       \&amp;depth=1\&amp;query=([^\"]+\">[^\<]+)</a>&gxis
185                                                                            if defined $gene_ontology;
186
187      # UNIPROT GO Functions
188      push @functions, map {s#\s*</a>\;?\s*# #g; $_;} m&<TD\s+VALIGN="top"\s+COLSPAN="5">
189                                                     <a\s+href="http://www.ebi.ac.uk/ego/GSearch\?query=[^\&+]\&mode=id">
190                                                     (GO\:\d+</a>\;\s+[^\<]+?)\s*</TD>&xgis;
191
192      $results[FUNCTION] = join('; ', map {(defined $_)?($_):()} @functions);
193      $results[FUNCTION] ||= 'NO FUNCTION';
194
195      # Figure out the keyword used
196      $results[KEYWORD] = $keyword;
197
198      $results[KEYWORD] ||= 'NO KEYWORD';
199
200      # Figure out what the description is
201      ($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;
202      if (not defined $results[DESCRIPTION]) {
203           ($results[DESCRIPTION]) = map{s#\n# #g; $_;} $result =~ m&<TD\s+BGCOLOR="\#CECFCE"\s+VALIGN="center"\s+COLSPAN="2">
204                                                                     <FONT\s+face="verdana,helvetica,arial,sans-serif"><B>FUNCTION</B></TD>\s*
205                                                                     <TD\s+VALIGN="top"\s+COLSPAN="4">([^\<]+)</TD>\s*</TR>&xis;
206      }
207      $results[DESCRIPTION] ||= '';
208
209      # Database searched
210      $results[DBNAME] = 'harvester';
211      $results[FILENAME] = $file_name;
212
213      print join(',',map {qq("$_")} @results),qq(\n);
214 }
215
216
217
218
219
220
221 __END__