[Bio] / Sprout / Sprout.pm Repository:
ViewVC logotype

Diff of /Sprout/Sprout.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.23, Fri Sep 9 21:15:47 2005 UTC revision 1.90, Fri Sep 29 15:10:05 2006 UTC
# Line 1  Line 1 
1  package Sprout;  package Sprout;
2    
3        require Exporter;
4        use ERDB;
5        @ISA = qw(Exporter ERDB);
6      use Data::Dumper;      use Data::Dumper;
7      use strict;      use strict;
8      use Carp;      use Carp;
# Line 7  Line 10 
10      use XML::Simple;      use XML::Simple;
11      use DBQuery;      use DBQuery;
12      use DBObject;      use DBObject;
     use ERDB;  
13      use Tracer;      use Tracer;
14      use FIGRules;      use FIGRules;
15        use FidCheck;
16      use Stats;      use Stats;
17      use POSIX qw(strftime);      use POSIX qw(strftime);
18        use BasicLocation;
19    
20  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
21    
# Line 32  Line 35 
35  query tasks. For example, L</genomes> lists the IDs of all the genomes in the database and  query tasks. For example, L</genomes> lists the IDs of all the genomes in the database and
36  L</dna_seq> returns the DNA sequence for a specified genome location.  L</dna_seq> returns the DNA sequence for a specified genome location.
37    
38    The Sprout object is a subclass of the ERDB object and inherits all its properties and methods.
39    
40  =cut  =cut
41    
42  #: Constructor SFXlate->new_sprout_only();  #: Constructor SFXlate->new_sprout_only();
# Line 62  Line 67 
67    
68  * B<xmlFileName> name of the XML file containing the database definition (default C<SproutDBD.xml>)  * B<xmlFileName> name of the XML file containing the database definition (default C<SproutDBD.xml>)
69    
70  * B<userData> user name and password, delimited by a slash (default C<root/>)  * B<userData> user name and password, delimited by a slash (default same as SEED)
71    
72  * B<port> connection port (default C<0>)  * B<port> connection port (default C<0>)
73    
74    * B<sock> connection socket (default same as SEED)
75    
76  * B<maxSegmentLength> maximum number of residues per feature segment, (default C<4500>)  * B<maxSegmentLength> maximum number of residues per feature segment, (default C<4500>)
77    
78  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)
79    
80    * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE
81    
82  =back  =back
83    
84  For example, the following constructor call specifies a database named I<Sprout> and a user name of  For example, the following constructor call specifies a database named I<Sprout> and a user name of
# Line 83  Line 92 
92  sub new {  sub new {
93      # Get the parameters.      # Get the parameters.
94      my ($class, $dbName, $options) = @_;      my ($class, $dbName, $options) = @_;
95        # Compute the DBD directory.
96        my $dbd_dir = (defined($FIG_Config::dbd_dir) ? $FIG_Config::dbd_dir :
97                                                      $FIG_Config::fig );
98      # Compute the options. We do this by starting with a table of defaults and overwriting with      # Compute the options. We do this by starting with a table of defaults and overwriting with
99      # the incoming data.      # the incoming data.
100      my $optionTable = Tracer::GetOptions({      my $optionTable = Tracer::GetOptions({
# Line 90  Line 102 
102                                                          # database type                                                          # database type
103                         dataDir      => $FIG_Config::sproutData,                         dataDir      => $FIG_Config::sproutData,
104                                                          # data file directory                                                          # data file directory
105                         xmlFileName  => "$FIG_Config::sproutData/SproutDBD.xml",                         xmlFileName  => "$dbd_dir/SproutDBD.xml",
106                                                          # database definition file name                                                          # database definition file name
107                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
108                                                          # user name and password                                                          # user name and password
109                         port         => $FIG_Config::dbport,                         port         => $FIG_Config::dbport,
110                                                          # database connection port                                                          # database connection port
111                           sock         => $FIG_Config::dbsock,
112                           host         => $FIG_Config::dbhost,
113                         maxSegmentLength => 4500,        # maximum feature segment length                         maxSegmentLength => 4500,        # maximum feature segment length
114                         maxSequenceLength => 8000,       # maximum contig sequence length                         maxSequenceLength => 8000,       # maximum contig sequence length
115                           noDBOpen     => 0,               # 1 to suppress the database open
116                        }, $options);                        }, $options);
117      # Get the data directory.      # Get the data directory.
118      my $dataDir = $optionTable->{dataDir};      my $dataDir = $optionTable->{dataDir};
# Line 105  Line 120 
120      $optionTable->{userData} =~ m!([^/]*)/(.*)$!;      $optionTable->{userData} =~ m!([^/]*)/(.*)$!;
121      my ($userName, $password) = ($1, $2);      my ($userName, $password) = ($1, $2);
122      # Connect to the database.      # Connect to the database.
123      my $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName, $password, $optionTable->{port});      my $dbh;
124        if (! $optionTable->{noDBOpen}) {
125            $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
126                                    $password, $optionTable->{port}, $optionTable->{host}, $optionTable->{sock});
127        }
128      # Create the ERDB object.      # Create the ERDB object.
129      my $xmlFileName = "$optionTable->{xmlFileName}";      my $xmlFileName = "$optionTable->{xmlFileName}";
130      my $erdb = ERDB->new($dbh, $xmlFileName);      my $retVal = ERDB::new($class, $dbh, $xmlFileName);
131      # Create this object.      # Add the option table and XML file name.
132      my $self = { _erdb => $erdb, _options => $optionTable, _xmlName => $xmlFileName };      $retVal->{_options} = $optionTable;
133      # Bless and return it.      $retVal->{_xmlName} = $xmlFileName;
134      bless $self;      # Set up space for the group file data.
135      return $self;      $retVal->{groupHash} = undef;
136        # Return it.
137        return $retVal;
138  }  }
139    
140  =head3 MaxSegment  =head3 MaxSegment
# Line 148  Line 169 
169      return $self->{_options}->{maxSequenceLength};      return $self->{_options}->{maxSequenceLength};
170  }  }
171    
 =head3 Get  
   
 C<< my $query = $sprout->Get(\@objectNames, $filterClause, \@parameterList); >>  
   
 This method allows a general query against the Sprout data using a specified filter clause.  
   
 The filter is a standard WHERE/ORDER BY clause with question marks as parameter markers and each  
 field name represented in the form B<I<objectName>(I<fieldName>)>. For example, the  
 following call requests all B<Genome> objects for the genus specified in the variable  
 $genus.  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ?", [$genus]); >>  
   
 The WHERE clause contains a single question mark, so there is a single additional  
 parameter representing the parameter value. It would also be possible to code  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = \'$genus\'"); >>  
   
 however, this version of the call would generate a syntax error if there were any quote  
 characters inside the variable C<$genus>.  
   
 The use of the strange parenthesized notation for field names enables us to distinguish  
 hyphens contained within field names from minus signs that participate in the computation  
 of the WHERE clause. All of the methods that manipulate fields will use this same notation.  
   
 It is possible to specify multiple entity and relationship names in order to retrieve more than  
 one object's data at the same time, which allows highly complex joined queries. For example,  
   
 C<< $query = $sprout->Get(['Genome', 'ComesFrom', 'Source'], "Genome(genus) = ?", [$genus]); >>  
   
 This query returns all the genomes for a particular genus and allows access to the  
 sources from which they came. The join clauses to go from Genome to Source are generated  
 automatically.  
   
 Finally, the filter clause can contain sort information. To do this, simply put an C<ORDER BY>  
 clause at the end of the filter. Field references in the ORDER BY section follow the same rules  
 as they do in the filter itself; in other words, each one must be of the form B<I<objectName>(I<fieldName>)>.  
 For example, the following filter string gets all genomes for a particular genus and sorts  
 them by species name.  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ? ORDER BY Genome(species)", [$genus]); >>  
   
 It is also permissible to specify I<only> an ORDER BY clause. For example, the following invocation gets  
 all genomes ordered by genus and species.  
   
 C<< $query = $sprout->Get(['Genome'], "ORDER BY Genome(genus), Genome(species)"); >>  
   
 Odd things may happen if one of the ORDER BY fields is in a secondary relation. So, for example, an  
 attempt to order B<Feature>s by alias may (depending on the underlying database engine used) cause  
 a single feature to appear more than once.  
   
 If multiple names are specified, then the query processor will automatically determine a  
 join path between the entities and relationships. The algorithm used is very simplistic.  
 In particular, you can't specify any entity or relationship more than once, and if a  
 relationship is recursive, the path is determined by the order in which the entity  
 and the relationship appear. For example, consider a recursive relationship B<IsParentOf>  
 which relates B<People> objects to other B<People> objects. If the join path is  
 coded as C<['People', 'IsParentOf']>, then the people returned will be parents. If, however,  
 the join path is C<['IsParentOf', 'People']>, then the people returned will be children.  
   
 =over 4  
   
 =item objectNames  
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item parameterList  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause.  
   
 =item RETURN  
   
 Returns a B<DBQuery> that can be used to iterate through all of the results.  
   
 =back  
   
 =cut  
   
 sub Get {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList) = @_;  
     # We differ from the ERDB Get method in that the parameter list is passed in as a list reference  
     # rather than a list of parameters. The next step is to convert the parameters from a reference  
     # to a real list. We can only do this if the parameters have been specified.  
     my @parameters;  
     if ($parameterList) { @parameters = @{$parameterList}; }  
     return $self->{_erdb}->Get($objectNames, $filterClause, @parameters);  
 }  
   
 =head3 GetEntity  
   
 C<< my $entityObject = $sprout->GetEntity($entityType, $ID); >>  
   
 Return an object describing the entity instance with a specified ID.  
   
 =over 4  
   
 =item entityType  
   
 Entity type name.  
   
 =item ID  
   
 ID of the desired entity.  
   
 =item RETURN  
   
 Returns a B<DBObject> representing the desired entity instance, or an undefined value if no  
 instance is found with the specified key.  
   
 =back  
   
 =cut  
   
 sub GetEntity {  
     # Get the parameters.  
     my ($self, $entityType, $ID) = @_;  
     # Call the ERDB method.  
     return $self->{_erdb}->GetEntity($entityType, $ID);  
 }  
   
 =head3 GetEntityValues  
   
 C<< my @values = GetEntityValues($entityType, $ID, \@fields); >>  
   
 Return a list of values from a specified entity instance.  
   
 =over 4  
   
 =item entityType  
   
 Entity type name.  
   
 =item ID  
   
 ID of the desired entity.  
   
 =item fields  
   
 List of field names, each of the form I<objectName>C<(>I<fieldName>C<)>.  
   
 =item RETURN  
   
 Returns a flattened list of the values of the specified fields for the specified entity.  
   
 =back  
   
 =cut  
 #: Return Type @;  
 sub GetEntityValues {  
     # Get the parameters.  
     my ($self, $entityType, $ID, $fields) = @_;  
     # Call the ERDB method.  
     return $self->{_erdb}->GetEntityValues($entityType, $ID, $fields);  
 }  
   
 =head3 ShowMetaData  
   
 C<< $sprout->ShowMetaData($fileName); >>  
   
 This method outputs a description of the database to an HTML file in the data directory.  
   
 =over 4  
   
 =item fileName  
   
 Fully-qualified name to give to the output file.  
   
 =back  
   
 =cut  
   
 sub ShowMetaData {  
     # Get the parameters.  
     my ($self, $fileName) = @_;  
     # Compute the file name.  
     my $options = $self->{_options};  
     # Call the show method on the underlying ERDB object.  
     $self->{_erdb}->ShowMetaData($fileName);  
 }  
   
172  =head3 Load  =head3 Load
173    
174  C<< $sprout->Load($rebuild); >>;  C<< $sprout->Load($rebuild); >>;
# Line 372  Line 203 
203  sub Load {  sub Load {
204      # Get the parameters.      # Get the parameters.
205      my ($self, $rebuild) = @_;      my ($self, $rebuild) = @_;
     # Get the database object.  
     my $erdb = $self->{_erdb};  
206      # Load the tables from the data directory.      # Load the tables from the data directory.
207      my $retVal = $erdb->LoadTables($self->{_options}->{dataDir}, $rebuild);      my $retVal = $self->LoadTables($self->{_options}->{dataDir}, $rebuild);
208      # Return the statistics.      # Return the statistics.
209      return $retVal;      return $retVal;
210  }  }
211    
212  =head3 LoadUpdate  =head3 LoadUpdate
213    
214  C<< my %stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>  C<< my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>
215    
216  Load updates to one or more database tables. This method enables the client to make changes to one  Load updates to one or more database tables. This method enables the client to make changes to one
217  or two tables without reloading the whole database. For each table, there must be a corresponding  or two tables without reloading the whole database. For each table, there must be a corresponding
# Line 415  Line 244 
244  sub LoadUpdate {  sub LoadUpdate {
245      # Get the parameters.      # Get the parameters.
246      my ($self, $truncateFlag, $tableList) = @_;      my ($self, $truncateFlag, $tableList) = @_;
     # Get the database object.  
     my $erdb = $self->{_erdb};  
247      # Declare the return value.      # Declare the return value.
248      my $retVal = Stats->new();      my $retVal = Stats->new();
249      # Get the data directory.      # Get the data directory.
# Line 430  Line 257 
257              Trace("No load file found for $tableName in $dataDir.") if T(0);              Trace("No load file found for $tableName in $dataDir.") if T(0);
258          } else {          } else {
259              # Attempt to load this table.              # Attempt to load this table.
260              my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);              my $result = $self->LoadTable($fileName, $tableName, $truncateFlag);
261              # Accumulate the resulting statistics.              # Accumulate the resulting statistics.
262              $retVal->Accumulate($result);              $retVal->Accumulate($result);
263          }          }
# Line 439  Line 266 
266      return $retVal;      return $retVal;
267  }  }
268    
269    =head3 GenomeCounts
270    
271    C<< my ($arch, $bact, $euk, $vir, $env, $unk) = $sprout->GenomeCounts($complete); >>
272    
273    Count the number of genomes in each domain. If I<$complete> is TRUE, only complete
274    genomes will be included in the counts.
275    
276    =over 4
277    
278    =item complete
279    
280    TRUE if only complete genomes are to be counted, FALSE if all genomes are to be
281    counted
282    
283    =item RETURN
284    
285    A six-element list containing the number of genomes in each of six categories--
286    Archaea, Bacteria, Eukaryota, Viral, Environmental, and Unknown, respectively.
287    
288    =back
289    
290    =cut
291    
292    sub GenomeCounts {
293        # Get the parameters.
294        my ($self, $complete) = @_;
295        # Set the filter based on the completeness flag.
296        my $filter = ($complete ? "Genome(complete) = 1" : "");
297        # Get all the genomes and the related taxonomy information.
298        my @genomes = $self->GetAll(['Genome'], $filter, [], ['Genome(id)', 'Genome(taxonomy)']);
299        # Clear the counters.
300        my ($arch, $bact, $euk, $vir, $env, $unk) = (0, 0, 0, 0, 0, 0);
301        # Loop through, counting the domains.
302        for my $genome (@genomes) {
303            if    ($genome->[1] =~ /^archaea/i)  { ++$arch }
304            elsif ($genome->[1] =~ /^bacter/i)   { ++$bact }
305            elsif ($genome->[1] =~ /^eukar/i)    { ++$euk }
306            elsif ($genome->[1] =~ /^vir/i)      { ++$vir }
307            elsif ($genome->[1] =~ /^env/i)      { ++$env }
308            else  { ++$unk }
309        }
310        # Return the counts.
311        return ($arch, $bact, $euk, $vir, $env, $unk);
312    }
313    
314    =head3 ContigCount
315    
316    C<< my $count = $sprout->ContigCount($genomeID); >>
317    
318    Return the number of contigs for the specified genome ID.
319    
320    =over 4
321    
322    =item genomeID
323    
324    ID of the genome whose contig count is desired.
325    
326    =item RETURN
327    
328    Returns the number of contigs for the specified genome.
329    
330    =back
331    
332    =cut
333    
334    sub ContigCount {
335        # Get the parameters.
336        my ($self, $genomeID) = @_;
337        # Get the contig count.
338        my $retVal = $self->GetCount(['Contig', 'HasContig'], "HasContig(from-link) = ?", [$genomeID]);
339        # Return the result.
340        return $retVal;
341    }
342    
343    =head3 GeneMenu
344    
345    C<< my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params, $selected); >>
346    
347    Return an HTML select menu of genomes. Each genome will be an option in the menu,
348    and will be displayed by name with the ID and a contig count attached. The selection
349    value will be the genome ID. The genomes will be sorted by genus/species name.
350    
351    =over 4
352    
353    =item attributes
354    
355    Reference to a hash mapping attributes to values for the SELECT tag generated.
356    
357    =item filterString
358    
359    A filter string for use in selecting the genomes. The filter string must conform
360    to the rules for the C<< ERDB->Get >> method.
361    
362    =item params
363    
364    Reference to a list of values to be substituted in for the parameter marks in
365    the filter string.
366    
367    =item selected (optional)
368    
369    ID of the genome to be initially selected.
370    
371    =item fast (optional)
372    
373    If specified and TRUE, the contig counts will be omitted to improve performance.
374    
375    =item RETURN
376    
377    Returns an HTML select menu with the specified genomes as selectable options.
378    
379    =back
380    
381    =cut
382    
383    sub GeneMenu {
384        # Get the parameters.
385        my ($self, $attributes, $filterString, $params, $selected, $fast) = @_;
386        my $slowMode = ! $fast;
387        # Default to nothing selected. This prevents an execution warning if "$selected"
388        # is undefined.
389        $selected = "" unless defined $selected;
390        Trace("Gene Menu called with slow mode \"$slowMode\" and selection \"$selected\".") if T(3);
391        # Start the menu.
392        my $retVal = "<select " .
393            join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .
394            ">\n";
395        # Get the genomes.
396        my @genomes = $self->GetAll(['Genome'], $filterString, $params, ['Genome(id)',
397                                                                         'Genome(genus)',
398                                                                         'Genome(species)',
399                                                                         'Genome(unique-characterization)']);
400        # Sort them by name.
401        my @sorted = sort { lc("$a->[1] $a->[2]") cmp lc("$b->[1] $b->[2]") } @genomes;
402        # Loop through the genomes, creating the option tags.
403        for my $genomeData (@sorted) {
404            # Get the data for this genome.
405            my ($genomeID, $genus, $species, $strain) = @{$genomeData};
406            # Get the contig count.
407            my $contigInfo = "";
408            if ($slowMode) {
409                my $count = $self->ContigCount($genomeID);
410                my $counting = ($count == 1 ? "contig" : "contigs");
411                $contigInfo = "[$count $counting]";
412            }
413            # Find out if we're selected.
414            my $selectOption = ($selected eq $genomeID ? " selected" : "");
415            # Build the option tag.
416            $retVal .= "<option value=\"$genomeID\"$selectOption>$genus $species $strain ($genomeID)$contigInfo</option>\n";
417        }
418        # Close the SELECT tag.
419        $retVal .= "</select>\n";
420        # Return the result.
421        return $retVal;
422    }
423    
424  =head3 Build  =head3 Build
425    
426  C<< $sprout->Build(); >>  C<< $sprout->Build(); >>
# Line 453  Line 435 
435      # Get the parameters.      # Get the parameters.
436      my ($self) = @_;      my ($self) = @_;
437      # Create the tables.      # Create the tables.
438      $self->{_erdb}->CreateTables;      $self->CreateTables();
439  }  }
440    
441  =head3 Genomes  =head3 Genomes
# Line 603  Line 585 
585          if ($prevContig eq $contigID && $dir eq $prevDir) {          if ($prevContig eq $contigID && $dir eq $prevDir) {
586              # Here the new segment is in the same direction on the same contig. Insure the              # Here the new segment is in the same direction on the same contig. Insure the
587              # new segment's beginning is next to the old segment's end.              # new segment's beginning is next to the old segment's end.
588              if (($dir eq "-" && $beg == $prevBeg - $prevLen) ||              if ($dir eq "-" && $beg + $len == $prevBeg) {
589                  ($dir eq "+" && $beg == $prevBeg + $prevLen)) {                  # Here we're merging two backward blocks, so we keep the new begin point
590                  # Here we need to merge two segments. Adjust the beginning and length values                  # and adjust the length.
591                  # to include both segments.                  $len += $prevLen;
592                    # Pop the old segment off. The new one will replace it later.
593                    pop @retVal;
594                } elsif ($dir eq "+" && $beg == $prevBeg + $prevLen) {
595                    # Here we need to merge two forward blocks. Adjust the beginning and
596                    # length values to include both segments.
597                  $beg = $prevBeg;                  $beg = $prevBeg;
598                  $len += $prevLen;                  $len += $prevLen;
599                  # Pop the old segment off. The new one will replace it later.                  # Pop the old segment off. The new one will replace it later.
# Line 615  Line 602 
602          }          }
603          # Remember this specifier for the adjacent-segment test the next time through.          # Remember this specifier for the adjacent-segment test the next time through.
604          ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);          ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);
605            # Compute the initial base pair.
606            my $start = ($dir eq "+" ? $beg : $beg + $len - 1);
607          # Add the specifier to the list.          # Add the specifier to the list.
608          push @retVal, "${contigID}_$beg$dir$len";          push @retVal, "${contigID}_$start$dir$len";
609      }      }
610      # Return the list in the format indicated by the context.      # Return the list in the format indicated by the context.
611      return (wantarray ? @retVal : join(',', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
# Line 650  Line 639 
639      shift if UNIVERSAL::isa($_[0],__PACKAGE__);      shift if UNIVERSAL::isa($_[0],__PACKAGE__);
640      my ($location) = @_;      my ($location) = @_;
641      # Parse it into segments.      # Parse it into segments.
642      $location =~ /^(.*)_(\d*)([+-_])(\d*)$/;      $location =~ /^(.+)_(\d+)([+\-_])(\d+)$/;
643      my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);      my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);
644      # If the direction is an underscore, convert it to a + or -.      # If the direction is an underscore, convert it to a + or -.
645      if ($dir eq "_") {      if ($dir eq "_") {
# Line 666  Line 655 
655      return ($contigID, $start, $dir, $len);      return ($contigID, $start, $dir, $len);
656  }  }
657    
658    
659    
660  =head3 PointLocation  =head3 PointLocation
661    
662  C<< my $found = Sprout::PointLocation($location, $point); >>  C<< my $found = Sprout::PointLocation($location, $point); >>
# Line 726  Line 717 
717  should be of the form returned by L</featureLocation> when in a list context. In other words,  should be of the form returned by L</featureLocation> when in a list context. In other words,
718  each location is of the form I<contigID>C<_>I<begin>I<dir>I<end>.  each location is of the form I<contigID>C<_>I<begin>I<dir>I<end>.
719    
720    For example, the following would return the DNA sequence for contig C<83333.1:NC_000913>
721    between positions 1401 and 1532, inclusive.
722    
723        my $sequence = $sprout->DNASeq('83333.1:NC_000913_1401_1532');
724    
725  =over 4  =over 4
726    
727  =item locationList  =item locationList
728    
729  List of location specifiers, each in the form I<contigID>C<_>I<begin>I<dir>I<end> (see  List of location specifiers, each in the form I<contigID>C<_>I<begin>I<dir>I<len> or
730  L</FeatureLocation> for more about this format).  I<contigID>C<_>I<begin>C<_>I<end> (see L</FeatureLocation> for more about this format).
731    
732  =item RETURN  =item RETURN
733    
# Line 758  Line 754 
754          # the start point is the ending. Note that in the latter case we must reverse the DNA string          # the start point is the ending. Note that in the latter case we must reverse the DNA string
755          # before putting it in the return value.          # before putting it in the return value.
756          my ($start, $stop);          my ($start, $stop);
757            Trace("Parse of \"$location\" is $beg$dir$len.") if T(SDNA => 4);
758          if ($dir eq "+") {          if ($dir eq "+") {
759              $start = $beg;              $start = $beg;
760              $stop = $beg + $len - 1;              $stop = $beg + $len - 1;
761          } else {          } else {
762              $start = $beg + $len + 1;              $start = $beg - $len + 1;
763              $stop = $beg;              $stop = $beg;
764          }          }
765            Trace("Looking for sequences containing $start through $stop.") if T(SDNA => 4);
766          my $query = $self->Get(['IsMadeUpOf','Sequence'],          my $query = $self->Get(['IsMadeUpOf','Sequence'],
767              "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .              "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .
768              " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",              " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",
# Line 776  Line 774 
774                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',
775                                     'IsMadeUpOf(len)']);                                     'IsMadeUpOf(len)']);
776              my $stopPosition = $startPosition + $sequenceLength;              my $stopPosition = $startPosition + $sequenceLength;
777                Trace("Sequence is from $startPosition to $stopPosition.") if T(SDNA => 4);
778              # Figure out the start point and length of the relevant section.              # Figure out the start point and length of the relevant section.
779              my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);              my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);
780              my $len = ($stopPosition <= $stop ? $stopPosition : $stop) - $startPosition - $pos1;              my $len1 = ($stopPosition < $stop ? $stopPosition : $stop) + 1 - $startPosition - $pos1;
781                Trace("Position is $pos1 for length $len1.") if T(SDNA => 4);
782              # Add the relevant data to the location data.              # Add the relevant data to the location data.
783              $locationDNA .= substr($sequenceData, $pos1, $len);              $locationDNA .= substr($sequenceData, $pos1, $len1);
784          }          }
785          # Add this location's data to the return string. Note that we may need to reverse it.          # Add this location's data to the return string. Note that we may need to reverse it.
786          if ($dir eq '+') {          if ($dir eq '+') {
787              $retVal .= $locationDNA;              $retVal .= $locationDNA;
788          } else {          } else {
789              $locationDNA = join('', reverse split //, $locationDNA);              $retVal .= FIG::reverse_comp($locationDNA);
             $retVal .= $locationDNA;  
790          }          }
791      }      }
792      # Return the result.      # Return the result.
# Line 824  Line 823 
823      return @retVal;      return @retVal;
824  }  }
825    
826    =head3 GenomeLength
827    
828    C<< my $length = $sprout->GenomeLength($genomeID); >>
829    
830    Return the length of the specified genome in base pairs.
831    
832    =over 4
833    
834    =item genomeID
835    
836    ID of the genome whose base pair count is desired.
837    
838    =item RETURN
839    
840    Returns the number of base pairs in all the contigs of the specified
841    genome.
842    
843    =back
844    
845    =cut
846    
847    sub GenomeLength {
848        # Get the parameters.
849        my ($self, $genomeID) = @_;
850        # Declare the return variable.
851        my $retVal = 0;
852        # Get the genome's contig sequence lengths.
853        my @lens = $self->GetFlat(['HasContig', 'IsMadeUpOf'], 'HasContig(from-link) = ?',
854                           [$genomeID], 'IsMadeUpOf(len)');
855        # Sum the lengths.
856        map { $retVal += $_ } @lens;
857        # Return the result.
858        return $retVal;
859    }
860    
861    =head3 FeatureCount
862    
863    C<< my $count = $sprout->FeatureCount($genomeID, $type); >>
864    
865    Return the number of features of the specified type in the specified genome.
866    
867    =over 4
868    
869    =item genomeID
870    
871    ID of the genome whose feature count is desired.
872    
873    =item type
874    
875    Type of feature to count (eg. C<peg>, C<rna>, etc.).
876    
877    =item RETURN
878    
879    Returns the number of features of the specified type for the specified genome.
880    
881    =back
882    
883    =cut
884    
885    sub FeatureCount {
886        # Get the parameters.
887        my ($self, $genomeID, $type) = @_;
888        # Compute the count.
889        my $retVal = $self->GetCount(['HasFeature', 'Feature'],
890                                    "HasFeature(from-link) = ? AND Feature(feature-type) = ?",
891                                    [$genomeID, $type]);
892        # Return the result.
893        return $retVal;
894    }
895    
896    =head3 GenomeAssignments
897    
898    C<< my $fidHash = $sprout->GenomeAssignments($genomeID); >>
899    
900    Return a list of a genome's assigned features. The return hash will contain each
901    assigned feature of the genome mapped to the text of its most recent functional
902    assignment.
903    
904    =over 4
905    
906    =item genomeID
907    
908    ID of the genome whose functional assignments are desired.
909    
910    =item RETURN
911    
912    Returns a reference to a hash which maps each feature to its most recent
913    functional assignment.
914    
915    =back
916    
917    =cut
918    
919    sub GenomeAssignments {
920        # Get the parameters.
921        my ($self, $genomeID) = @_;
922        # Declare the return variable.
923        my $retVal = {};
924        # Query the genome's features and annotations. We'll put the oldest annotations
925        # first so that the last assignment to go into the hash will be the correct one.
926        my $query = $self->Get(['HasFeature', 'IsTargetOfAnnotation', 'Annotation'],
927                               "HasFeature(from-link) = ? ORDER BY Annotation(time)",
928                               [$genomeID]);
929        # Loop through the annotations.
930        while (my $data = $query->Fetch) {
931            # Get the feature ID and annotation text.
932            my ($fid, $annotation) = $data->Values(['HasFeature(to-link)',
933                                                    'Annotation(annotation)']);
934            # Check to see if this is an assignment. Note that the user really
935            # doesn't matter to us, other than we use it to determine whether or
936            # not this is an assignment.
937            my ($user, $assignment) = _ParseAssignment('fig', $annotation);
938            if ($user) {
939                # Here it's an assignment. We put it in the return hash, overwriting
940                # any older assignment that might be present.
941                $retVal->{$fid} = $assignment;
942            }
943        }
944        # Return the result.
945        return $retVal;
946    }
947    
948  =head3 ContigLength  =head3 ContigLength
949    
950  C<< my $length = $sprout->ContigLength($contigID); >>  C<< my $length = $sprout->ContigLength($contigID); >>
# Line 857  Line 978 
978      # Set it from the sequence data, if any.      # Set it from the sequence data, if any.
979      if ($sequence) {      if ($sequence) {
980          my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);          my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);
981          $retVal = $start + $len;          $retVal = $start + $len - 1;
982      }      }
983      # Return the result.      # Return the result.
984      return $retVal;      return $retVal;
985  }  }
986    
987  =head3 GenesInRegion  =head3 ClusterPEGs
988    
989  C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>  C<< my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs); >>
990    
991  List the features which overlap a specified region in a contig.  Cluster the PEGs in a list according to the cluster coding scheme of the specified
992    subsystem. In order for this to work properly, the subsystem object must have
993    been used recently to retrieve the PEGs using the B<get_pegs_from_cell> method.
994    This causes the cluster numbers to be pulled into the subsystem's color hash.
995    If a PEG is not found in the color hash, it will not appear in the output
996    sequence.
997    
998  =over 4  =over 4
999    
1000  =item contigID  =item sub
1001    
1002  ID of the contig containing the region of interest.  Sprout subsystem object for the relevant subsystem, from the L</get_subsystem>
1003    method.
1004    
1005  =item start  =item pegs
1006    
1007  Offset of the first residue in the region of interest.  Reference to the list of PEGs to be clustered.
1008    
1009  =item stop  =item RETURN
1010    
1011    Returns a list of the PEGs, grouped into smaller lists by cluster number.
1012    
1013    =back
1014    
1015    =cut
1016    #: Return Type $@@;
1017    sub ClusterPEGs {
1018        # Get the parameters.
1019        my ($self, $sub, $pegs) = @_;
1020        # Declare the return variable.
1021        my $retVal = [];
1022        # Loop through the PEGs, creating arrays for each cluster.
1023        for my $pegID (@{$pegs}) {
1024            my $clusterNumber = $sub->get_cluster_number($pegID);
1025            # Only proceed if the PEG is in a cluster.
1026            if ($clusterNumber >= 0) {
1027                # Push this PEG onto the sub-list for the specified cluster number.
1028                push @{$retVal->[$clusterNumber]}, $pegID;
1029            }
1030        }
1031        # Return the result.
1032        return $retVal;
1033    }
1034    
1035    =head3 GenesInRegion
1036    
1037    C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>
1038    
1039    List the features which overlap a specified region in a contig.
1040    
1041    =over 4
1042    
1043    =item contigID
1044    
1045    ID of the contig containing the region of interest.
1046    
1047    =item start
1048    
1049    Offset of the first residue in the region of interest.
1050    
1051    =item stop
1052    
1053  Offset of the last residue in the region of interest.  Offset of the last residue in the region of interest.
1054    
# Line 1007  Line 1176 
1176    
1177  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1178    
1179  C<< my @descriptors = $sprout->FeatureAnnotations($featureID); >>  C<< my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag); >>
1180    
1181  Return the annotations of a feature.  Return the annotations of a feature.
1182    
# Line 1017  Line 1186 
1186    
1187  ID of the feature whose annotations are desired.  ID of the feature whose annotations are desired.
1188    
1189    =item rawFlag
1190    
1191    If TRUE, the annotation timestamps will be returned in raw form; otherwise, they
1192    will be returned in human-readable form.
1193    
1194  =item RETURN  =item RETURN
1195    
1196  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.
1197    
1198  * B<featureID> ID of the relevant feature.  * B<featureID> ID of the relevant feature.
1199    
1200  * B<timeStamp> time the annotation was made, in user-friendly format.  * B<timeStamp> time the annotation was made.
1201    
1202  * B<user> ID of the user who made the annotation  * B<user> ID of the user who made the annotation
1203    
# Line 1035  Line 1209 
1209  #: Return Type @%;  #: Return Type @%;
1210  sub FeatureAnnotations {  sub FeatureAnnotations {
1211      # Get the parameters.      # Get the parameters.
1212      my ($self, $featureID) = @_;      my ($self, $featureID, $rawFlag) = @_;
1213      # Create a query to get the feature's annotations and the associated users.      # Create a query to get the feature's annotations and the associated users.
1214      my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],      my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1215                             "IsTargetOfAnnotation(from-link) = ?", [$featureID]);                             "IsTargetOfAnnotation(from-link) = ?", [$featureID]);
# Line 1048  Line 1222 
1222              $annotation->Values(['IsTargetOfAnnotation(from-link)',              $annotation->Values(['IsTargetOfAnnotation(from-link)',
1223                                   'Annotation(time)', 'MadeAnnotation(from-link)',                                   'Annotation(time)', 'MadeAnnotation(from-link)',
1224                                   'Annotation(annotation)']);                                   'Annotation(annotation)']);
1225            # Convert the time, if necessary.
1226            if (! $rawFlag) {
1227                $timeStamp = FriendlyTimestamp($timeStamp);
1228            }
1229          # Assemble them into a hash.          # Assemble them into a hash.
1230          my $annotationHash = { featureID => $featureID,          my $annotationHash = { featureID => $featureID,
1231                                 timeStamp => FriendlyTimestamp($timeStamp),                                 timeStamp => $timeStamp,
1232                                 user => $user, text => $text };                                 user => $user, text => $text };
1233          # Add it to the return list.          # Add it to the return list.
1234          push @retVal, $annotationHash;          push @retVal, $annotationHash;
# Line 1079  Line 1257 
1257    
1258  =item RETURN  =item RETURN
1259    
1260  Returns a hash mapping the functional assignment IDs to user IDs.  Returns a hash mapping the user IDs to functional assignment IDs.
1261    
1262  =back  =back
1263    
# Line 1089  Line 1267 
1267      # Get the parameters.      # Get the parameters.
1268      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1269      # Get all of the feature's annotations.      # Get all of the feature's annotations.
1270      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1271                              "IsTargetOfAnnotation(from-link) = ?",                              "IsTargetOfAnnotation(from-link) = ?",
1272                              [$featureID], ['Annotation(time)', 'Annotation(annotation)']);                              [$featureID], ['Annotation(time)', 'Annotation(annotation)',
1273                                               'MadeAnnotation(from-link)']);
1274      # Declare the return hash.      # Declare the return hash.
1275      my %retVal;      my %retVal;
     # Declare a hash for insuring we only make one assignment per user.  
     my %timeHash = ();  
1276      # Now we sort the assignments by timestamp in reverse.      # Now we sort the assignments by timestamp in reverse.
1277      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;
1278      # Loop until we run out of annotations.      # Loop until we run out of annotations.
1279      for my $annotation (@sortedQuery) {      for my $annotation (@sortedQuery) {
1280          # Get the annotation fields.          # Get the annotation fields.
1281          my ($timeStamp, $text) = @{$annotation};          my ($timeStamp, $text, $user) = @{$annotation};
1282          # Check to see if this is a functional assignment.          # Check to see if this is a functional assignment.
1283          my ($user, $function) = _ParseAssignment($text);          my ($actualUser, $function) = _ParseAssignment($user, $text);
1284          if ($user && ! exists $timeHash{$user}) {          if ($actualUser && ! exists $retVal{$actualUser}) {
1285              # Here it is a functional assignment and there has been no              # Here it is a functional assignment and there has been no
1286              # previous assignment for this user, so we stuff it in the              # previous assignment for this user, so we stuff it in the
1287              # return hash.              # return hash.
1288              $retVal{$function} = $user;              $retVal{$actualUser} = $function;
             # Insure we don't assign to this user again.  
             $timeHash{$user} = 1;  
1289          }          }
1290      }      }
1291      # Return the hash of assignments found.      # Return the hash of assignments found.
# Line 1126  Line 1301 
1301  The functional assignment is handled differently depending on the type of feature. If  The functional assignment is handled differently depending on the type of feature. If
1302  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1303  assignment is a type of annotation. The format of an assignment is described in  assignment is a type of annotation. The format of an assignment is described in
1304  L</ParseLocation>. Its worth noting that we cannot filter on the content of the  L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1305  annotation itself because it's a text field; however, this is not a big problem because  annotation itself because it's a text field; however, this is not a big problem because
1306  most features only have a small number of annotations.  most features only have a small number of annotations.
1307    
# Line 1188  Line 1363 
1363              }              }
1364          }          }
1365          # Build a query for all of the feature's annotations, sorted by date.          # Build a query for all of the feature's annotations, sorted by date.
1366          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1367                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1368                                 [$featureID]);                                 [$featureID]);
1369          my $timeSelected = 0;          my $timeSelected = 0;
1370          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1371          while (my $annotation = $query->Fetch()) {          while (my $annotation = $query->Fetch()) {
1372              # Get the annotation text.              # Get the annotation text.
1373              my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);              my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1374                                                         'Annotation(time)', 'MadeAnnotation(from-link)']);
1375              # Check to see if this is a functional assignment for a trusted user.              # Check to see if this is a functional assignment for a trusted user.
1376              my ($user, $function) = _ParseAssignment($text);              my ($actualUser, $function) = _ParseAssignment($user, $text);
1377              if ($user) {              Trace("Assignment user is $actualUser, text is $function.") if T(4);
1378                if ($actualUser) {
1379                  # Here it is a functional assignment. Check the time and the user                  # Here it is a functional assignment. Check the time and the user
1380                  # name. The time must be recent and the user must be trusted.                  # name. The time must be recent and the user must be trusted.
1381                  if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {                  if ((exists $trusteeTable{$actualUser}) && ($time > $timeSelected)) {
1382                      $retVal = $function;                      $retVal = $function;
1383                      $timeSelected = $time;                      $timeSelected = $time;
1384                  }                  }
# Line 1217  Line 1394 
1394      return $retVal;      return $retVal;
1395  }  }
1396    
1397    =head3 FunctionsOf
1398    
1399    C<< my @functionList = $sprout->FunctionOf($featureID, $userID); >>
1400    
1401    Return the functional assignments of a particular feature.
1402    
1403    The functional assignment is handled differently depending on the type of feature. If
1404    the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1405    assignment is a type of annotation. The format of an assignment is described in
1406    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1407    annotation itself because it's a text field; however, this is not a big problem because
1408    most features only have a small number of annotations.
1409    
1410    If the feature is B<not> identified by a FIG ID, then the functional assignment
1411    information is taken from the B<ExternalAliasFunc> table. If the table does
1412    not contain an entry for the feature, an empty list is returned.
1413    
1414    =over 4
1415    
1416    =item featureID
1417    
1418    ID of the feature whose functional assignments are desired.
1419    
1420    =item RETURN
1421    
1422    Returns a list of 2-tuples, each consisting of a user ID and the text of an assignment by
1423    that user.
1424    
1425    =back
1426    
1427    =cut
1428    #: Return Type @@;
1429    sub FunctionsOf {
1430        # Get the parameters.
1431        my ($self, $featureID) = @_;
1432        # Declare the return value.
1433        my @retVal = ();
1434        # Determine the ID type.
1435        if ($featureID =~ m/^fig\|/) {
1436            # Here we have a FIG feature ID. We must build the list of trusted
1437            # users.
1438            my %trusteeTable = ();
1439            # Build a query for all of the feature's annotations, sorted by date.
1440            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1441                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1442                                   [$featureID]);
1443            my $timeSelected = 0;
1444            # Loop until we run out of annotations.
1445            while (my $annotation = $query->Fetch()) {
1446                # Get the annotation text.
1447                my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1448                                                                'Annotation(time)',
1449                                                                'MadeAnnotation(user)']);
1450                # Check to see if this is a functional assignment for a trusted user.
1451                my ($actualUser, $function) = _ParseAssignment($user, $text);
1452                if ($actualUser) {
1453                    # Here it is a functional assignment.
1454                    push @retVal, [$actualUser, $function];
1455                }
1456            }
1457        } else {
1458            # Here we have a non-FIG feature ID. In this case the user ID does not
1459            # matter. We simply get the information from the External Alias Function
1460            # table.
1461            my @assignments = $self->GetEntityValues('ExternalAliasFunc', $featureID,
1462                                                     ['ExternalAliasFunc(func)']);
1463            push @retVal, map { ['master', $_] } @assignments;
1464        }
1465        # Return the assignments found.
1466        return @retVal;
1467    }
1468    
1469  =head3 BBHList  =head3 BBHList
1470    
1471  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>
# Line 1250  Line 1499 
1499      my %retVal = ();      my %retVal = ();
1500      # Loop through the incoming features.      # Loop through the incoming features.
1501      for my $featureID (@{$featureList}) {      for my $featureID (@{$featureList}) {
1502          # Create a query to get the feature's best hit.          # Ask the server for the feature's best hit.
1503          my $query = $self->Get(['IsBidirectionalBestHitOf'],          my @bbhData = FIGRules::BBHData($featureID);
1504                                 "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",          # Peel off the BBHs found.
1505                                 [$featureID, $genomeID]);          my @found = ();
1506          # Look for the best hit.          for my $bbh (@bbhData) {
1507          my $bbh = $query->Fetch;              push @found, $bbh->[0];
         if ($bbh) {  
             my ($targetFeature) = $bbh->Value('IsBidirectionalBestHitOf(to-link)');  
             $retVal{$featureID} = $targetFeature;  
1508          }          }
1509            $retVal{$featureID} = \@found;
1510      }      }
1511      # Return the mapping.      # Return the mapping.
1512      return \%retVal;      return \%retVal;
# Line 1271  Line 1518 
1518    
1519  Return a list of the similarities to the specified feature.  Return a list of the similarities to the specified feature.
1520    
1521  Sprout does not support real similarities, so this method just returns the bidirectional  This method just returns the bidirectional best hits for performance reasons.
 best hits.  
1522    
1523  =over 4  =over 4
1524    
# Line 1292  Line 1538 
1538      # Get the parameters.      # Get the parameters.
1539      my ($self, $featureID, $count) = @_;      my ($self, $featureID, $count) = @_;
1540      # Ask for the best hits.      # Ask for the best hits.
1541      my @lists = $self->GetAll(['IsBidirectionalBestHitOf'],      my @lists = FIGRules::BBHData($featureID);
                               "IsBidirectionalBestHitOf(from-link) = ? ORDER BY IsBidirectionalBestHitOf(score) DESC",  
                               [$featureID], ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(score)'],  
                               $count);  
1542      # Create the return value.      # Create the return value.
1543      my %retVal = ();      my %retVal = ();
1544      for my $tuple (@lists) {      for my $tuple (@lists) {
# Line 1305  Line 1548 
1548      return %retVal;      return %retVal;
1549  }  }
1550    
   
   
1551  =head3 IsComplete  =head3 IsComplete
1552    
1553  C<< my $flag = $sprout->IsComplete($genomeID); >>  C<< my $flag = $sprout->IsComplete($genomeID); >>
# Line 1337  Line 1578 
1578      my $genomeData = $self->GetEntity('Genome', $genomeID);      my $genomeData = $self->GetEntity('Genome', $genomeID);
1579      if ($genomeData) {      if ($genomeData) {
1580          # The genome exists, so get the completeness flag.          # The genome exists, so get the completeness flag.
1581          ($retVal) = $genomeData->Value('complete');          ($retVal) = $genomeData->Value('Genome(complete)');
1582      }      }
1583      # Return the result.      # Return the result.
1584      return $retVal;      return $retVal;
# Line 1377  Line 1618 
1618    
1619  C<< my $genomeID = $sprout->GenomeOf($featureID); >>  C<< my $genomeID = $sprout->GenomeOf($featureID); >>
1620    
1621  Return the genome that contains a specified feature.  Return the genome that contains a specified feature or contig.
1622    
1623  =over 4  =over 4
1624    
1625  =item featureID  =item featureID
1626    
1627  ID of the feature whose genome is desired.  ID of the feature or contig whose genome is desired.
1628    
1629  =item RETURN  =item RETURN
1630    
1631  Returns the ID of the genome for the specified feature. If the feature is not found, returns  Returns the ID of the genome for the specified feature or contig. If the feature or contig is not
1632  an undefined value.  found, returns an undefined value.
1633    
1634  =back  =back
1635    
# Line 1397  Line 1638 
1638  sub GenomeOf {  sub GenomeOf {
1639      # Get the parameters.      # Get the parameters.
1640      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1641      # Create a query to find the genome associated with the feature.      # Create a query to find the genome associated with the incoming ID.
1642      my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);      my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ? OR HasContig(to-link) = ?",
1643                               [$featureID, $featureID]);
1644      # Declare the return value.      # Declare the return value.
1645      my $retVal;      my $retVal;
1646      # Get the genome ID.      # Get the genome ID.
# Line 1433  Line 1675 
1675  sub CoupledFeatures {  sub CoupledFeatures {
1676      # Get the parameters.      # Get the parameters.
1677      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1678        Trace("Looking for features coupled to $featureID.") if T(coupling => 3);
1679      # Create a query to retrieve the functionally-coupled features.      # Create a query to retrieve the functionally-coupled features.
1680      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],
1681                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);
# Line 1445  Line 1688 
1688          # Get the ID and score of the coupling.          # Get the ID and score of the coupling.
1689          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',
1690                                                          'Coupling(score)']);                                                          'Coupling(score)']);
1691          # The coupling ID contains the two feature IDs separated by a space. We use          Trace("$featureID coupled with score $score to ID $couplingID.") if T(coupling => 4);
1692          # this information to find the ID of the other feature.          # Get the other feature that participates in the coupling.
1693          my ($fid1, $fid2) = split / /, $couplingID;          my ($otherFeatureID) = $self->GetFlat(['ParticipatesInCoupling'],
1694          my $otherFeatureID = ($featureID eq $fid1 ? $fid2 : $fid1);                                             "ParticipatesInCoupling(to-link) = ? AND ParticipatesInCoupling(from-link) <> ?",
1695                                               [$couplingID, $featureID], 'ParticipatesInCoupling(from-link)');
1696            Trace("$couplingID target feature is $otherFeatureID.") if T(coupling => 4);
1697          # Attach the other feature's score to its ID.          # Attach the other feature's score to its ID.
1698          $retVal{$otherFeatureID} = $score;          $retVal{$otherFeatureID} = $score;
1699          $found = 1;          $found = 1;
# Line 1581  Line 1826 
1826      my ($self, $peg1, $peg2) = @_;      my ($self, $peg1, $peg2) = @_;
1827      # Declare the return values. We'll start with the coupling ID and undefine the      # Declare the return values. We'll start with the coupling ID and undefine the
1828      # flag and score until we have more information.      # flag and score until we have more information.
1829      my ($retVal, $inverted, $score) = (CouplingID($peg1, $peg2), undef, undef);      my ($retVal, $inverted, $score) = ($self->CouplingID($peg1, $peg2), undef, undef);
1830      # Find the coupling data.      # Find the coupling data.
1831      my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],      my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],
1832                                   "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",                                   "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",
# Line 1602  Line 1847 
1847      return ($retVal, $inverted, $score);      return ($retVal, $inverted, $score);
1848  }  }
1849    
1850    =head3 GetSynonymGroup
1851    
1852    C<< my $id = $sprout->GetSynonymGroup($fid); >>
1853    
1854    Return the synonym group name for the specified feature.
1855    
1856    =over 4
1857    
1858    =item fid
1859    
1860    ID of the feature whose synonym group is desired.
1861    
1862    =item RETURN
1863    
1864    The name of the synonym group to which the feature belongs. If the feature does
1865    not belong to a synonym group, the feature ID itself is returned.
1866    
1867    =back
1868    
1869    =cut
1870    
1871    sub GetSynonymGroup {
1872        # Get the parameters.
1873        my ($self, $fid) = @_;
1874        # Declare the return variable.
1875        my $retVal;
1876        # Find the synonym group.
1877        my @groups = $self->GetFlat(['IsSynonymGroupFor'], "IsSynonymGroupFor(to-link) = ?",
1878                                       [$fid], 'IsSynonymGroupFor(from-link)');
1879        # Check to see if we found anything.
1880        if (@groups) {
1881            $retVal = $groups[0];
1882        } else {
1883            $retVal = $fid;
1884        }
1885        # Return the result.
1886        return $retVal;
1887    }
1888    
1889    =head3 GetBoundaries
1890    
1891    C<< my ($contig, $beg, $end) = $sprout->GetBoundaries(@locList); >>
1892    
1893    Determine the begin and end boundaries for the locations in a list. All of the
1894    locations must belong to the same contig and have mostly the same direction in
1895    order for this method to produce a meaningful result. The resulting
1896    begin/end pair will contain all of the bases in any of the locations.
1897    
1898    =over 4
1899    
1900    =item locList
1901    
1902    List of locations to process.
1903    
1904    =item RETURN
1905    
1906    Returns a 3-tuple consisting of the contig ID, the beginning boundary,
1907    and the ending boundary. The beginning boundary will be left of the
1908    end for mostly-forward locations and right of the end for mostly-backward
1909    locations.
1910    
1911    =back
1912    
1913    =cut
1914    
1915    sub GetBoundaries {
1916        # Get the parameters.
1917        my ($self, @locList) = @_;
1918        # Set up the counters used to determine the most popular direction.
1919        my %counts = ( '+' => 0, '-' => 0 );
1920        # Get the last location and parse it.
1921        my $locObject = BasicLocation->new(pop @locList);
1922        # Prime the loop with its data.
1923        my ($contig, $beg, $end) = ($locObject->Contig, $locObject->Left, $locObject->Right);
1924        # Count its direction.
1925        $counts{$locObject->Dir}++;
1926        # Loop through the remaining locations. Note that in most situations, this loop
1927        # will not iterate at all, because most of the time we will be dealing with a
1928        # singleton list.
1929        for my $loc (@locList) {
1930            # Create a location object.
1931            my $locObject = BasicLocation->new($loc);
1932            # Count the direction.
1933            $counts{$locObject->Dir}++;
1934            # Get the left end and the right end.
1935            my $left = $locObject->Left;
1936            my $right = $locObject->Right;
1937            # Merge them into the return variables.
1938            if ($left < $beg) {
1939                $beg = $left;
1940            }
1941            if ($right > $end) {
1942                $end = $right;
1943            }
1944        }
1945        # If the most common direction is reverse, flip the begin and end markers.
1946        if ($counts{'-'} > $counts{'+'}) {
1947            ($beg, $end) = ($end, $beg);
1948        }
1949        # Return the result.
1950        return ($contig, $beg, $end);
1951    }
1952    
1953  =head3 CouplingID  =head3 CouplingID
1954    
1955  C<< my $couplingID = Sprout::CouplingID($peg1, $peg2); >>  C<< my $couplingID = $sprout->CouplingID($peg1, $peg2); >>
1956    
1957  Return the coupling ID for a pair of feature IDs.  Return the coupling ID for a pair of feature IDs.
1958    
# Line 1637  Line 1985 
1985  =cut  =cut
1986  #: Return Type $;  #: Return Type $;
1987  sub CouplingID {  sub CouplingID {
1988      return join " ", sort @_;      my ($self, @pegs) = @_;
1989  }      return $self->DigestKey(join " ", sort @pegs);
   
 =head3 GetEntityTypes  
   
 C<< my @entityList = $sprout->GetEntityTypes(); >>  
   
 Return the list of supported entity types.  
   
 =cut  
 #: Return Type @;  
 sub GetEntityTypes {  
     # Get the parameters.  
     my ($self) = @_;  
     # Get the underlying database object.  
     my $erdb = $self->{_erdb};  
     # Get its entity type list.  
     my @retVal = $erdb->GetEntityTypes();  
1990  }  }
1991    
1992  =head3 ReadFasta  =head3 ReadFasta
# Line 1701  Line 2033 
2033          if ($line =~ m/^>\s*(.+?)(\s|\n)/) {          if ($line =~ m/^>\s*(.+?)(\s|\n)/) {
2034              # Here we have a new header. Store the current sequence if we have one.              # Here we have a new header. Store the current sequence if we have one.
2035              if ($id) {              if ($id) {
2036                  $retVal{$id} = uc $sequence;                  $retVal{$id} = lc $sequence;
2037              }              }
2038              # Clear the sequence accumulator and save the new ID.              # Clear the sequence accumulator and save the new ID.
2039              ($id, $sequence) = ("$prefix$1", "");              ($id, $sequence) = ("$prefix$1", "");
2040          } else {          } else {
2041              # Here we have a data line, so we add it to the sequence accumulator.              # Here we have a data line, so we add it to the sequence accumulator.
2042              # First, we get the actual data out. Note that we normalize to upper              # First, we get the actual data out. Note that we normalize to lower
2043              # case.              # case.
2044              $line =~ /^\s*(.*?)(\s|\n)/;              $line =~ /^\s*(.*?)(\s|\n)/;
2045              $sequence .= $1;              $sequence .= $1;
# Line 1715  Line 2047 
2047      }      }
2048      # Flush out the last sequence (if any).      # Flush out the last sequence (if any).
2049      if ($sequence) {      if ($sequence) {
2050          $retVal{$id} = uc $sequence;          $retVal{$id} = lc $sequence;
2051      }      }
2052      # Close the file.      # Close the file.
2053      close FASTAFILE;      close FASTAFILE;
# Line 1802  Line 2134 
2134      # Get the data directory name.      # Get the data directory name.
2135      my $outputDirectory = $self->{_options}->{dataDir};      my $outputDirectory = $self->{_options}->{dataDir};
2136      # Dump the relations.      # Dump the relations.
2137      $self->{_erdb}->DumpRelations($outputDirectory);      $self->DumpRelations($outputDirectory);
2138  }  }
2139    
2140  =head3 XMLFileName  =head3 XMLFileName
# Line 1854  Line 2186 
2186      # Get the parameters.      # Get the parameters.
2187      my ($self, $objectType, $fieldHash) = @_;      my ($self, $objectType, $fieldHash) = @_;
2188      # Call the underlying method.      # Call the underlying method.
2189      $self->{_erdb}->InsertObject($objectType, $fieldHash);      $self->InsertObject($objectType, $fieldHash);
2190  }  }
2191    
2192  =head3 Annotate  =head3 Annotate
# Line 2013  Line 2345 
2345      return @retVal;      return @retVal;
2346  }  }
2347    
 =head3 Exists  
   
 C<< my $found = $sprout->Exists($entityName, $entityID); >>  
   
 Return TRUE if an entity exists, else FALSE.  
   
 =over 4  
   
 =item entityName  
   
 Name of the entity type (e.g. C<Feature>) relevant to the existence check.  
   
 =item entityID  
   
 ID of the entity instance whose existence is to be checked.  
   
 =item RETURN  
   
 Returns TRUE if the entity instance exists, else FALSE.  
   
 =back  
   
 =cut  
 #: Return Type $;  
 sub Exists {  
     # Get the parameters.  
     my ($self, $entityName, $entityID) = @_;  
     # Check for the entity instance.  
     my $testInstance = $self->GetEntity($entityName, $entityID);  
     # Return an existence indicator.  
     my $retVal = ($testInstance ? 1 : 0);  
     return $retVal;  
 }  
   
2348  =head3 FeatureTranslation  =head3 FeatureTranslation
2349    
2350  C<< my $translation = $sprout->FeatureTranslation($featureID); >>  C<< my $translation = $sprout->FeatureTranslation($featureID); >>
# Line 2381  Line 2679 
2679      return $retVal;      return $retVal;
2680  }  }
2681    
2682    =head3 PropertyID
2683    
2684    C<< my $id = $sprout->PropertyID($propName, $propValue); >>
2685    
2686    Return the ID of the specified property name and value pair, if the
2687    pair exists.
2688    
2689    =over 4
2690    
2691    =item propName
2692    
2693    Name of the desired property.
2694    
2695    =item propValue
2696    
2697    Value expected for the desired property.
2698    
2699    =item RETURN
2700    
2701    Returns the ID of the name/value pair, or C<undef> if the pair does not exist.
2702    
2703    =back
2704    
2705    =cut
2706    
2707    sub PropertyID {
2708        # Get the parameters.
2709        my ($self, $propName, $propValue) = @_;
2710        # Try to find the ID.
2711        my ($retVal) = $self->GetFlat(['Property'],
2712                                      "Property(property-name) = ? AND Property(property-value) = ?",
2713                                      [$propName, $propValue], 'Property(id)');
2714        # Return the result.
2715        return $retVal;
2716    }
2717    
2718  =head3 MergedAnnotations  =head3 MergedAnnotations
2719    
2720  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>
# Line 2534  Line 2868 
2868                                      ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);                                      ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);
2869      # Create the return value.      # Create the return value.
2870      my %retVal = ();      my %retVal = ();
2871        # Build a hash to weed out duplicates. Sometimes the same PEG and role appears
2872        # in two spreadsheet cells.
2873        my %dupHash = ();
2874      # Loop through the results, adding them to the hash.      # Loop through the results, adding them to the hash.
2875      for my $record (@subsystems) {      for my $record (@subsystems) {
2876            # Get this subsystem and role.
2877          my ($subsys, $role) = @{$record};          my ($subsys, $role) = @{$record};
2878          if (exists $retVal{$subsys}) {          # Insure it's the first time for both.
2879            my $dupKey = "$subsys\n$role";
2880            if (! exists $dupHash{"$subsys\n$role"}) {
2881                $dupHash{$dupKey} = 1;
2882              push @{$retVal{$subsys}}, $role;              push @{$retVal{$subsys}}, $role;
         } else {  
             $retVal{$subsys} = [$role];  
2883          }          }
2884      }      }
2885      # Return the hash.      # Return the hash.
# Line 2573  Line 2912 
2912      # Get the parameters.      # Get the parameters.
2913      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2914      # Get the list of names.      # Get the list of names.
2915      my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",      my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",
2916                                  [$featureID], 'HasSSCell(from-link)');                                  [$featureID], 'HasRoleInSubsystem(to-link)');
2917        # Return the result, sorted.
2918        return sort @retVal;
2919    }
2920    
2921    =head3 GenomeSubsystemData
2922    
2923    C<< my %featureData = $sprout->GenomeSubsystemData($genomeID); >>
2924    
2925    Return a hash mapping genome features to their subsystem roles.
2926    
2927    =over 4
2928    
2929    =item genomeID
2930    
2931    ID of the genome whose subsystem feature map is desired.
2932    
2933    =item RETURN
2934    
2935    Returns a hash mapping each feature of the genome to a list of 2-tuples. Eacb
2936    2-tuple contains a subsystem name followed by a role ID.
2937    
2938    =back
2939    
2940    =cut
2941    
2942    sub GenomeSubsystemData {
2943        # Get the parameters.
2944        my ($self, $genomeID) = @_;
2945        # Declare the return variable.
2946        my %retVal = ();
2947        # Get a list of the genome features that participate in subsystems. For each
2948        # feature we get its spreadsheet cells and the corresponding roles.
2949        my @roleData = $self->GetAll(['HasFeature', 'ContainsFeature', 'IsRoleOf'],
2950                                 "HasFeature(from-link) = ?", [$genomeID],
2951                                 ['HasFeature(to-link)', 'IsRoleOf(to-link)', 'IsRoleOf(from-link)']);
2952        # Now we get a list of the spreadsheet cells and their associated subsystems. Subsystems
2953        # with an unknown variant code (-1) are skipped. Note the genome ID is at both ends of the
2954        # list. We use it at the beginning to get all the spreadsheet cells for the genome and
2955        # again at the end to filter out participation in subsystems with a negative variant code.
2956        my @cellData = $self->GetAll(['IsGenomeOf', 'HasSSCell', 'ParticipatesIn'],
2957                                     "IsGenomeOf(from-link) = ? AND ParticipatesIn(variant-code) >= 0 AND ParticipatesIn(from-link) = ?",
2958                                     [$genomeID, $genomeID], ['HasSSCell(to-link)', 'HasSSCell(from-link)']);
2959        # Now "@roleData" lists the spreadsheet cell and role for each of the genome's features.
2960        # "@cellData" lists the subsystem name for each of the genome's spreadsheet cells. We
2961        # link these two lists together to create the result. First, we want a hash mapping
2962        # spreadsheet cells to subsystem names.
2963        my %subHash = map { $_->[0] => $_->[1] } @cellData;
2964        # We loop through @cellData to build the hash.
2965        for my $roleEntry (@roleData) {
2966            # Get the data for this feature and cell.
2967            my ($fid, $cellID, $role) = @{$roleEntry};
2968            # Check for a subsystem name.
2969            my $subsys = $subHash{$cellID};
2970            if ($subsys) {
2971                # Insure this feature has an entry in the return hash.
2972                if (! exists $retVal{$fid}) { $retVal{$fid} = []; }
2973                # Merge in this new data.
2974                push @{$retVal{$fid}}, [$subsys, $role];
2975            }
2976        }
2977      # Return the result.      # Return the result.
2978      return @retVal;      return %retVal;
2979  }  }
2980    
2981  =head3 RelatedFeatures  =head3 RelatedFeatures
# Line 2614  Line 3013 
3013      # Get the parameters.      # Get the parameters.
3014      my ($self, $featureID, $function, $userID) = @_;      my ($self, $featureID, $function, $userID) = @_;
3015      # Get a list of the features that are BBHs of the incoming feature.      # Get a list of the features that are BBHs of the incoming feature.
3016      my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],      my @bbhFeatures = map { $_->[0] } FIGRules::BBHData($featureID);
                                      "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],  
                                      'IsBidirectionalBestHitOf(to-link)');  
3017      # Now we loop through the features, pulling out the ones that have the correct      # Now we loop through the features, pulling out the ones that have the correct
3018      # functional assignment.      # functional assignment.
3019      my @retVal = ();      my @retVal = ();
# Line 2680  Line 3077 
3077      return @retVal;      return @retVal;
3078  }  }
3079    
 =head3 GetAll  
   
 C<< my @list = $sprout->GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count); >>  
   
 Return a list of values taken from the objects returned by a query. The first three  
 parameters correspond to the parameters of the L</Get> method. The final parameter is  
 a list of the fields desired from each record found by the query. The field name  
 syntax is the standard syntax used for fields in the B<ERDB> system--  
 B<I<objectName>(I<fieldName>)>-- where I<objectName> is the name of the relevant entity  
 or relationship and I<fieldName> is the name of the field.  
   
 The list returned will be a list of lists. Each element of the list will contain  
 the values returned for the fields specified in the fourth parameter. If one of the  
 fields specified returns multiple values, they are flattened in with the rest. For  
 example, the following call will return a list of the features in a particular  
 spreadsheet cell, and each feature will be represented by a list containing the  
 feature ID followed by all of its aliases.  
   
 C<< $query = $sprout->Get(['ContainsFeature', 'Feature'], "ContainsFeature(from-link) = ?", [$ssCellID], ['Feature(id)', 'Feature(alias)']); >>  
   
 =over 4  
   
 =item objectNames  
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item parameterList  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause.  
   
 =item fields  
   
 List of the fields to be returned in each element of the list returned.  
   
 =item count  
   
 Maximum number of records to return. If omitted or 0, all available records will be returned.  
   
 =item RETURN  
   
 Returns a list of list references. Each element of the return list contains the values for the  
 fields specified in the B<fields> parameter.  
   
 =back  
   
 =cut  
 #: Return Type @@;  
 sub GetAll {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList, $fields, $count) = @_;  
     # Call the ERDB method.  
     my @retVal = $self->{_erdb}->GetAll($objectNames, $filterClause, $parameterList,  
                                         $fields, $count);  
     # Return the resulting list.  
     return @retVal;  
 }  
   
 =head3 GetFlat  
   
 C<< my @list = $sprout->GetFlat(\@objectNames, $filterClause, $parameterList, $field); >>  
   
 This is a variation of L</GetAll> that asks for only a single field per record and  
 returns a single flattened list.  
   
 =over 4  
   
 =item objectNames  
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item parameterList  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause.  
   
 =item field  
   
 Name of the field to be used to get the elements of the list returned.  
   
 =item RETURN  
   
 Returns a list of values.  
   
 =back  
   
 =cut  
 #: Return Type @;  
 sub GetFlat {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList, $field) = @_;  
     # Construct the query.  
     my $query = $self->Get($objectNames, $filterClause, $parameterList);  
     # Create the result list.  
     my @retVal = ();  
     # Loop through the records, adding the field values found to the result list.  
     while (my $row = $query->Fetch()) {  
         push @retVal, $row->Value($field);  
     }  
     # Return the list created.  
     return @retVal;  
 }  
   
3080  =head3 Protein  =head3 Protein
3081    
3082  C<< my $protein = Sprout::Protein($sequence, $table); >>  C<< my $protein = Sprout::Protein($sequence, $table); >>
# Line 2900  Line 3178 
3178      # Create the return list, priming it with the name of the data directory.      # Create the return list, priming it with the name of the data directory.
3179      my @retVal = ($self->{_options}->{dataDir});      my @retVal = ($self->{_options}->{dataDir});
3180      # Concatenate the table names.      # Concatenate the table names.
3181      push @retVal, $self->{_erdb}->GetTableNames();      push @retVal, $self->GetTableNames();
3182      # Return the result.      # Return the result.
3183      return @retVal;      return @retVal;
3184  }  }
3185    
3186  =head3 LowBBHs  =head3 LowBBHs
3187    
3188  C<< my %bbhMap = $sprout->GoodBBHs($featureID, $cutoff); >>  C<< my %bbhMap = $sprout->LowBBHs($featureID, $cutoff); >>
3189    
3190  Return the bidirectional best hits of a feature whose score is no greater than a  Return the bidirectional best hits of a feature whose score is no greater than a
3191  specified cutoff value. A higher cutoff value will allow inclusion of hits with  specified cutoff value. A higher cutoff value will allow inclusion of hits with
# Line 2936  Line 3214 
3214      my ($self, $featureID, $cutoff) = @_;      my ($self, $featureID, $cutoff) = @_;
3215      # Create the return hash.      # Create the return hash.
3216      my %retVal = ();      my %retVal = ();
3217      # Create a query to get the desired BBHs.      # Query for the desired BBHs.
3218      my @bbhList = $self->GetAll(['IsBidirectionalBestHitOf'],      my @bbhList = FIGRules::BBHData($featureID, $cutoff);
                                 'IsBidirectionalBestHitOf(sc) <= ? AND IsBidirectionalBestHitOf(from-link) = ?',  
                                 [$cutoff, $featureID],  
                                 ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(sc)']);  
3219      # Form the results into the return hash.      # Form the results into the return hash.
3220      for my $pair (@bbhList) {      for my $pair (@bbhList) {
3221          $retVal{$pair->[0]} = $pair->[1];          $retVal{$pair->[0]} = $pair->[1];
# Line 2949  Line 3224 
3224      return %retVal;      return %retVal;
3225  }  }
3226    
3227    =head3 Sims
3228    
3229    C<< my $simList = $sprout->Sims($fid, $maxN, $maxP, $select, $max_expand, $filters); >>
3230    
3231    Get a list of similarities for a specified feature. Similarity information is not kept in the
3232    Sprout database; rather, they are retrieved from a network server. The similarities are
3233    returned as B<Sim> objects. A Sim object is actually a list reference that has been blessed
3234    so that its elements can be accessed by name.
3235    
3236    Similarities can be either raw or expanded. The raw similarities are basic
3237    hits between features with similar DNA. Expanding a raw similarity drags in any
3238    features considered substantially identical. So, for example, if features B<A1>,
3239    B<A2>, and B<A3> are all substatially identical to B<A>, then a raw similarity
3240    B<[C,A]> would be expanded to B<[C,A] [C,A1] [C,A2] [C,A3]>.
3241    
3242    =over 4
3243    
3244    =item fid
3245    
3246    ID of the feature whose similarities are desired.
3247    
3248    =item maxN
3249    
3250    Maximum number of similarities to return.
3251    
3252    =item maxP
3253    
3254    Minumum allowable similarity score.
3255    
3256    =item select
3257    
3258    Selection criterion: C<raw> means only raw similarities are returned; C<fig>
3259    means only similarities to FIG features are returned; C<all> means all expanded
3260    similarities are returned; and C<figx> means similarities are expanded until the
3261    number of FIG features equals the maximum.
3262    
3263    =item max_expand
3264    
3265    The maximum number of features to expand.
3266    
3267    =item filters
3268    
3269    Reference to a hash containing filter information, or a subroutine that can be
3270    used to filter the sims.
3271    
3272    =item RETURN
3273    
3274    Returns a reference to a list of similarity objects, or C<undef> if an error
3275    occurred.
3276    
3277    =back
3278    
3279    =cut
3280    
3281    sub Sims {
3282        # Get the parameters.
3283        my ($self, $fid, $maxN, $maxP, $select, $max_expand, $filters) = @_;
3284        # Create the shim object to test for deleted FIDs.
3285        my $shim = FidCheck->new($self);
3286        # Ask the network for sims.
3287        my $retVal = FIGRules::GetNetworkSims($shim, $fid, {}, $maxN, $maxP, $select, $max_expand, $filters);
3288        # Return the result.
3289        return $retVal;
3290    }
3291    
3292    =head3 IsAllGenomes
3293    
3294    C<< my $flag = $sprout->IsAllGenomes(\@list, \@checkList); >>
3295    
3296    Return TRUE if all genomes in the second list are represented in the first list at
3297    least one. Otherwise, return FALSE. If the second list is omitted, the first list is
3298    compared to a list of all the genomes.
3299    
3300    =over 4
3301    
3302    =item list
3303    
3304    Reference to the list to be compared to the second list.
3305    
3306    =item checkList (optional)
3307    
3308    Reference to the comparison target list. Every genome ID in this list must occur at
3309    least once in the first list. If this parameter is omitted, a list of all the genomes
3310    is used.
3311    
3312    =item RETURN
3313    
3314    Returns TRUE if every item in the second list appears at least once in the
3315    first list, else FALSE.
3316    
3317    =back
3318    
3319    =cut
3320    
3321    sub IsAllGenomes {
3322        # Get the parameters.
3323        my ($self, $list, $checkList) = @_;
3324        # Supply the checklist if it was omitted.
3325        $checkList = [$self->Genomes()] if ! defined($checkList);
3326        # Create a hash of the original list.
3327        my %testList = map { $_ => 1 } @{$list};
3328        # Declare the return variable. We assume that the representation
3329        # is complete and stop at the first failure.
3330        my $retVal = 1;
3331        my $n = scalar @{$checkList};
3332        for (my $i = 0; $retVal && $i < $n; $i++) {
3333            if (! $testList{$checkList->[$i]}) {
3334                $retVal = 0;
3335            }
3336        }
3337        # Return the result.
3338        return $retVal;
3339    }
3340    
3341  =head3 GetGroups  =head3 GetGroups
3342    
3343  C<< my %groups = $sprout->GetGroups(\@groupList); >>  C<< my %groups = $sprout->GetGroups(\@groupList); >>
# Line 2970  Line 3359 
3359          # Here we have a group list. Loop through them individually,          # Here we have a group list. Loop through them individually,
3360          # getting a list of the relevant genomes.          # getting a list of the relevant genomes.
3361          for my $group (@{$groupList}) {          for my $group (@{$groupList}) {
3362              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(group-name) = ?",              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(primary-group) = ?",
3363                  [$group], "Genome(id)");                  [$group], "Genome(id)");
3364              $retVal{$group} = \@genomeIDs;              $retVal{$group} = \@genomeIDs;
3365          }          }
# Line 2978  Line 3367 
3367          # Here we need all of the groups. In this case, we run through all          # Here we need all of the groups. In this case, we run through all
3368          # of the genome records, putting each one found into the appropriate          # of the genome records, putting each one found into the appropriate
3369          # group. Note that we use a filter clause to insure that only genomes          # group. Note that we use a filter clause to insure that only genomes
3370          # in groups are included in the return set.          # in real NMPDR groups are included in the return set.
3371          my @genomes = $self->GetAll(['Genome'], "Genome(group-name) > ' '", [],          my @genomes = $self->GetAll(['Genome'], "Genome(primary-group) <> ?",
3372                                      ['Genome(id)', 'Genome(group-name)']);                                      [$FIG_Config::otherGroup], ['Genome(id)', 'Genome(primary-group)']);
3373          # Loop through the genomes found.          # Loop through the genomes found.
3374          for my $genome (@genomes) {          for my $genome (@genomes) {
3375              # Pop this genome's ID off the current list.              # Pop this genome's ID off the current list.
# Line 3070  Line 3459 
3459      return $retVal;      return $retVal;
3460  }  }
3461    
3462  =head2 Internal Utility Methods  =head3 DeleteGenome
3463    
3464  =head3 ParseAssignment  C<< my $stats = $sprout->DeleteGenome($genomeID, $testFlag); >>
3465    
3466  Parse annotation text to determine whether or not it is a functional assignment. If it is,  Delete a genome from the database.
 the user, function text, and assigning user will be returned as a 3-element list. If it  
 isn't, an empty list will be returned.  
3467    
3468  A functional assignment is always of the form  =over 4
3469    
3470      I<XXXX>C<\nset >I<YYYY>C< function to\n>I<ZZZZZ>  =item genomeID
3471    
3472  where I<XXXX> is the B<assigning user>, I<YYYY> is the B<user>, and I<ZZZZ> is the  ID of the genome to delete
 actual functional role. In most cases, the user and the assigning user will be the  
 same, but that is not always the case.  
3473    
3474  This is a static method.  =item testFlag
3475    
3476    If TRUE, then the DELETE statements will be traced, but no deletions will occur.
3477    
3478    =item RETURN
3479    
3480    Returns a statistics object describing the rows deleted.
3481    
3482    =back
3483    
3484    =cut
3485    #: Return Type $%;
3486    sub DeleteGenome {
3487        # Get the parameters.
3488        my ($self, $genomeID, $testFlag) = @_;
3489        # Perform the delete for the genome's features.
3490        my $retVal = $self->Delete('Feature', "fig|$genomeID.%", $testFlag);
3491        # Perform the delete for the primary genome data.
3492        my $stats = $self->Delete('Genome', $genomeID, $testFlag);
3493        $retVal->Accumulate($stats);
3494        # Return the result.
3495        return $retVal;
3496    }
3497    
3498    =head3 Fix
3499    
3500    C<< my %fixedHash = Sprout::Fix(%groupHash); >>
3501    
3502    Prepare a genome group hash (like that returned by L</GetGroups> for processing.
3503    Groups with the same primary name will be combined. The primary name is the
3504    first capitalized word in the group name.
3505    
3506  =over 4  =over 4
3507    
3508  =item text  =item groupHash
3509    
3510  Text of the annotation.  Hash to be fixed up.
3511    
3512  =item RETURN  =item RETURN
3513    
3514  Returns an empty list if the annotation is not a functional assignment; otherwise, returns  Returns a fixed-up version of the hash.
 a two-element list containing the user name and the function text.  
3515    
3516  =back  =back
3517    
3518  =cut  =cut
3519    
3520  sub _ParseAssignment {  sub Fix {
3521      # Get the parameters.      # Get the parameters.
3522      my ($text) = @_;      my (%groupHash) = @_;
3523      # Declare the return value.      # Create the result hash.
3524      my @retVal = ();      my %retVal = ();
3525      # Check to see if this is a functional assignment.      # Copy over the genomes.
3526      my ($user, $type, $function) = split(/\n/, $text);      for my $groupID (keys %groupHash) {
3527      if ($type =~ m/^set ([^ ]+) function to$/i) {          # Make a safety copy of the group ID.
3528          # Here it is, so we return the user name (which is in $1), the functional role text,          my $realGroupID = $groupID;
3529          # and the assigning user.          # Yank the primary name.
3530          @retVal = ($1, $function, $user);          if ($groupID =~ /([A-Z]\w+)/) {
3531                $realGroupID = $1;
3532      }      }
3533      # Return the result list.          # Append this group's genomes into the result hash.
3534      return @retVal;          Tracer::AddToListMap(\%retVal, $realGroupID, @{$groupHash{$groupID}});
3535        }
3536        # Return the result hash.
3537        return %retVal;
3538  }  }
3539    
3540  =head3 FriendlyTimestamp  =head3 GroupPageName
3541    
3542  Convert a time number to a user-friendly time stamp for display.  C<< my $name = $sprout->GroupPageName($group); >>
3543    
3544  This is a static method.  Return the name of the page for the specified NMPDR group.
3545    
3546  =over 4  =over 4
3547    
3548  =item timeValue  =item group
3549    
3550  Numeric time value.  Name of the relevant group.
3551    
3552  =item RETURN  =item RETURN
3553    
3554  Returns a string containing the same time in user-readable format.  Returns the relative page name (e.g. C<../content/campy.php>). If the group file is not in
3555    memory it will be read in.
3556    
3557  =back  =back
3558    
3559  =cut  =cut
3560    
3561  sub FriendlyTimestamp {  sub GroupPageName {
3562      my ($timeValue) = @_;      # Get the parameters.
3563      my $retVal = strftime("%a %b %e %H:%M:%S %Y", localtime($timeValue));      my ($self, $group) = @_;
3564        # Declare the return variable.
3565        my $retVal;
3566        # Check for the group file data.
3567        if (! defined $self->{groupHash}) {
3568            # Read the group file.
3569            my %groupData = Sprout::ReadGroupFile($self->{_options}->{dataDir} . "/groups.tbl");
3570            # Store it in our object.
3571            $self->{groupHash} = \%groupData;
3572        }
3573        # Compute the real group name.
3574        my $realGroup = $group;
3575        if ($group =~ /([A-Z]\w+)/) {
3576            $realGroup = $1;
3577        }
3578        # Return the page name.
3579        $retVal = "../content/" . $self->{groupHash}->{$realGroup}->[1];
3580        # Return the result.
3581      return $retVal;      return $retVal;
3582  }  }
3583    
3584    =head3 ReadGroupFile
3585    
3586    C<< my %groupData = Sprout::ReadGroupFile($groupFileName); >>
3587    
3588    Read in the data from the specified group file. The group file contains information
3589    about each of the NMPDR groups.
3590    
3591    =over 4
3592    
3593    =item name
3594    
3595    Name of the group.
3596    
3597    =item page
3598    
3599    Name of the group's page on the web site (e.g. C<campy.php> for
3600    Campylobacter)
3601    
3602    =item genus
3603    
3604    Genus of the group
3605    
3606    =item species
3607    
3608    Species of the group, or an empty string if the group is for an entire
3609    genus. If the group contains more than one species, the species names
3610    should be separated by commas.
3611    
3612    =back
3613    
3614    The parameters to this method are as follows
3615    
3616    =over 4
3617    
3618    =item groupFile
3619    
3620    Name of the file containing the group data.
3621    
3622    =item RETURN
3623    
3624    Returns a hash keyed on group name. The value of each hash
3625    
3626    =back
3627    
3628    =cut
3629    
3630    sub ReadGroupFile {
3631        # Get the parameters.
3632        my ($groupFileName) = @_;
3633        # Declare the return variable.
3634        my %retVal;
3635        # Read the group file.
3636        my @groupLines = Tracer::GetFile($groupFileName);
3637        for my $groupLine (@groupLines) {
3638            my ($name, $page, $genus, $species) = split(/\t/, $groupLine);
3639            $retVal{$name} = [$page, $genus, $species];
3640        }
3641        # Return the result.
3642        return %retVal;
3643    }
3644    
3645  =head3 AddProperty  =head3 AddProperty
3646    
3647  C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>  C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>
# Line 3202  Line 3699 
3699      $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });      $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });
3700  }  }
3701    
3702    =head2 Internal Utility Methods
3703    
3704    =head3 ParseAssignment
3705    
3706    Parse annotation text to determine whether or not it is a functional assignment. If it is,
3707    the user, function text, and assigning user will be returned as a 3-element list. If it
3708    isn't, an empty list will be returned.
3709    
3710    A functional assignment is always of the form
3711    
3712        C<set >I<YYYY>C< function to\n>I<ZZZZZ>
3713    
3714    where I<YYYY> is the B<user>, and I<ZZZZ> is the actual functional role. In most cases,
3715    the user and the assigning user (from MadeAnnotation) will be the same, but that is
3716    not always the case.
3717    
3718    In addition, the functional role may contain extra data that is stripped, such as
3719    terminating spaces or a comment separated from the rest of the text by a tab.
3720    
3721    This is a static method.
3722    
3723    =over 4
3724    
3725    =item user
3726    
3727    Name of the assigning user.
3728    
3729    =item text
3730    
3731    Text of the annotation.
3732    
3733    =item RETURN
3734    
3735    Returns an empty list if the annotation is not a functional assignment; otherwise, returns
3736    a two-element list containing the user name and the function text.
3737    
3738    =back
3739    
3740    =cut
3741    
3742    sub _ParseAssignment {
3743        # Get the parameters.
3744        my ($user, $text) = @_;
3745        # Declare the return value.
3746        my @retVal = ();
3747        # Check to see if this is a functional assignment.
3748        my ($type, $function) = split(/\n/, $text);
3749        if ($type =~ m/^set function to$/i) {
3750            # Here we have an assignment without a user, so we use the incoming user ID.
3751            @retVal = ($user, $function);
3752        } elsif ($type =~ m/^set (\S+) function to$/i) {
3753            # Here we have an assignment with a user that is passed back to the caller.
3754            @retVal = ($1, $function);
3755        }
3756        # If we have an assignment, we need to clean the function text. There may be
3757        # extra junk at the end added as a note from the user.
3758        if (defined( $retVal[1] )) {
3759            $retVal[1] =~ s/(\t\S)?\s*$//;
3760        }
3761        # Return the result list.
3762        return @retVal;
3763    }
3764    
3765    =head3 FriendlyTimestamp
3766    
3767    Convert a time number to a user-friendly time stamp for display.
3768    
3769    This is a static method.
3770    
3771    =over 4
3772    
3773    =item timeValue
3774    
3775    Numeric time value.
3776    
3777    =item RETURN
3778    
3779    Returns a string containing the same time in user-readable format.
3780    
3781    =back
3782    
3783    =cut
3784    
3785    sub FriendlyTimestamp {
3786        my ($timeValue) = @_;
3787        my $retVal = localtime($timeValue);
3788        return $retVal;
3789    }
3790    
3791    
3792  1;  1;

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.90

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3