[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.60, Wed Jun 14 19:47:19 2006 UTC revision 1.105, Wed Jan 30 22:14:02 2008 UTC
# Line 1  Line 1 
1  package Sprout;  package Sprout;
2    
     require Exporter;  
     use ERDB;  
     @ISA = qw(Exporter ERDB);  
3      use Data::Dumper;      use Data::Dumper;
4      use strict;      use strict;
     use Carp;  
5      use DBKernel;      use DBKernel;
6      use XML::Simple;      use XML::Simple;
7      use DBQuery;      use DBQuery;
8      use DBObject;      use ERDBObject;
9      use Tracer;      use Tracer;
10      use FIGRules;      use FIGRules;
11        use FidCheck;
12      use Stats;      use Stats;
13      use POSIX qw(strftime);      use POSIX qw(strftime);
14        use BasicLocation;
15        use CustomAttributes;
16        use RemoteCustomAttributes;
17        use base qw(ERDB);
18    
19  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
20    
# Line 27  Line 27 
27  on the constructor. For example, the following invocation specifies a PostgreSQL database named I<GenDB>  on the constructor. For example, the following invocation specifies a PostgreSQL database named I<GenDB>
28  whose definition and data files are in a co-directory named F<Data>.  whose definition and data files are in a co-directory named F<Data>.
29    
30  C<< my $sprout = Sprout->new('GenDB', { dbType => 'pg', dataDir => '../Data', xmlFileName => '../Data/SproutDBD.xml' }); >>      my $sprout = Sprout->new('GenDB', { dbType => 'pg', dataDir => '../Data', xmlFileName => '../Data/SproutDBD.xml' });
31    
32  Once you have a sprout object, you may use it to re-create the database, load the tables from  Once you have a sprout object, you may use it to re-create the database, load the tables from
33  tab-delimited flat files and perform queries. Several special methods are provided for common  tab-delimited flat files and perform queries. Several special methods are provided for common
34  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
35  L</dna_seq> returns the DNA sequence for a specified genome location.  L</DNASeq> returns the DNA sequence for a specified genome location.
36    
37  The Sprout object is a subclass of the ERDB object and inherits all its properties and methods.  The Sprout object is a subclass of the ERDB object and inherits all its properties and methods.
38    
# Line 44  Line 44 
44    
45  =head3 new  =head3 new
46    
47  C<< my $sprout = Sprout->new($dbName, \%options); >>      my $sprout = Sprout->new($dbName, \%options);
48    
49  This is the constructor for a sprout object. It connects to the database and loads the  This is the constructor for a sprout object. It connects to the database and loads the
50  database definition into memory. The positional first parameter specifies the name of the  database definition into memory. The positional first parameter specifies the name of the
# Line 78  Line 78 
78    
79  * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE  * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE
80    
81    * B<host> name of the database host
82    
83  =back  =back
84    
85  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
86  I<fig> with a password of I<admin>. The database load files are in the directory  I<fig> with a password of I<admin>. The database load files are in the directory
87  F</usr/fig/SproutData>.  F</usr/fig/SproutData>.
88    
89  C<< my $sprout = Sprout->new('Sprout', { userData =>; 'fig/admin', dataDir => '/usr/fig/SproutData' }); >>      my $sprout = Sprout->new('Sprout', { userData => 'fig/admin', dataDir => '/usr/fig/SproutData' });
90    
91  =cut  =cut
92    
93  sub new {  sub new {
94      # Get the parameters.      # Get the parameters.
95      my ($class, $dbName, $options) = @_;      my ($class, $dbName, $options) = @_;
96        # Compute the DBD directory.
97        my $dbd_dir = (defined($FIG_Config::dbd_dir) ? $FIG_Config::dbd_dir :
98                                                      $FIG_Config::fig );
99      # 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
100      # the incoming data.      # the incoming data.
101      my $optionTable = Tracer::GetOptions({      my $optionTable = Tracer::GetOptions({
# Line 98  Line 103 
103                                                          # database type                                                          # database type
104                         dataDir      => $FIG_Config::sproutData,                         dataDir      => $FIG_Config::sproutData,
105                                                          # data file directory                                                          # data file directory
106                         xmlFileName  => "$FIG_Config::fig/SproutDBD.xml",                         xmlFileName  => "$dbd_dir/SproutDBD.xml",
107                                                          # database definition file name                                                          # database definition file name
108                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
109                                                          # user name and password                                                          # user name and password
110                         port         => $FIG_Config::dbport,                         port         => $FIG_Config::dbport,
111                                                          # database connection port                                                          # database connection port
112                         sock         => $FIG_Config::dbsock,                         sock         => $FIG_Config::dbsock,
113                           host         => $FIG_Config::sprout_host,
114                         maxSegmentLength => 4500,        # maximum feature segment length                         maxSegmentLength => 4500,        # maximum feature segment length
115                         maxSequenceLength => 8000,       # maximum contig sequence length                         maxSequenceLength => 8000,       # maximum contig sequence length
116                         noDBOpen     => 0,               # 1 to suppress the database open                         noDBOpen     => 0,               # 1 to suppress the database open
# Line 117  Line 123 
123      # Connect to the database.      # Connect to the database.
124      my $dbh;      my $dbh;
125      if (! $optionTable->{noDBOpen}) {      if (! $optionTable->{noDBOpen}) {
126            Trace("Connect data: host = $optionTable->{host}, port = $optionTable->{port}.") if T(3);
127          $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,          $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
128                                  $password, $optionTable->{port}, undef, $optionTable->{sock});                                  $password, $optionTable->{port}, $optionTable->{host}, $optionTable->{sock});
129      }      }
130      # Create the ERDB object.      # Create the ERDB object.
131      my $xmlFileName = "$optionTable->{xmlFileName}";      my $xmlFileName = "$optionTable->{xmlFileName}";
# Line 126  Line 133 
133      # Add the option table and XML file name.      # Add the option table and XML file name.
134      $retVal->{_options} = $optionTable;      $retVal->{_options} = $optionTable;
135      $retVal->{_xmlName} = $xmlFileName;      $retVal->{_xmlName} = $xmlFileName;
136        # Set up space for the group file data.
137        $retVal->{groupHash} = undef;
138        # Set up space for the genome hash. We use this to identify NMPDR genomes.
139        $retVal->{genomeHash} = undef;
140        # Connect to the attributes.
141        if ($FIG_Config::attrURL) {
142            Trace("Remote attribute server $FIG_Config::attrURL chosen.") if T(3);
143            $retVal->{_ca} = RemoteCustomAttributes->new($FIG_Config::attrURL);
144        } elsif ($FIG_Config::attrDbName) {
145            Trace("Local attribute database $FIG_Config::attrDbName chosen.") if T(3);
146            my $user = ($FIG_Config::arch eq 'win' ? 'self' : scalar(getpwent()));
147            $retVal->{_ca} = CustomAttributes->new(user => $user);
148        }
149      # Return it.      # Return it.
150      return $retVal;      return $retVal;
151  }  }
152    
153  =head3 MaxSegment  =head3 MaxSegment
154    
155  C<< my $length = $sprout->MaxSegment(); >>      my $length = $sprout->MaxSegment();
156    
157  This method returns the maximum permissible length of a feature segment. The length is important  This method returns the maximum permissible length of a feature segment. The length is important
158  because it enables us to make reasonable guesses at how to find features inside a particular  because it enables us to make reasonable guesses at how to find features inside a particular
# Line 149  Line 169 
169    
170  =head3 MaxSequence  =head3 MaxSequence
171    
172  C<< my $length = $sprout->MaxSequence(); >>      my $length = $sprout->MaxSequence();
173    
174  This method returns the maximum permissible length of a contig sequence. A contig is broken  This method returns the maximum permissible length of a contig sequence. A contig is broken
175  into sequences in order to save memory resources. In particular, when manipulating features,  into sequences in order to save memory resources. In particular, when manipulating features,
# Line 164  Line 184 
184    
185  =head3 Load  =head3 Load
186    
187  C<< $sprout->Load($rebuild); >>;      $sprout->Load($rebuild);;
188    
189  Load the database from files in the data directory, optionally re-creating the tables.  Load the database from files in the data directory, optionally re-creating the tables.
190    
# Line 204  Line 224 
224    
225  =head3 LoadUpdate  =head3 LoadUpdate
226    
227  C<< my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>      my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList);
228    
229  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
230  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 250  Line 270 
270              Trace("No load file found for $tableName in $dataDir.") if T(0);              Trace("No load file found for $tableName in $dataDir.") if T(0);
271          } else {          } else {
272              # Attempt to load this table.              # Attempt to load this table.
273              my $result = $self->LoadTable($fileName, $tableName, $truncateFlag);              my $result = $self->LoadTable($fileName, $tableName, truncate => $truncateFlag);
274              # Accumulate the resulting statistics.              # Accumulate the resulting statistics.
275              $retVal->Accumulate($result);              $retVal->Accumulate($result);
276          }          }
# Line 261  Line 281 
281    
282  =head3 GenomeCounts  =head3 GenomeCounts
283    
284  C<< my ($arch, $bact, $euk, $vir, $env, $unk) = $sprout->GenomeCounts($complete); >>      my ($arch, $bact, $euk, $vir, $env, $unk) = $sprout->GenomeCounts($complete);
285    
286  Count the number of genomes in each domain. If I<$complete> is TRUE, only complete  Count the number of genomes in each domain. If I<$complete> is TRUE, only complete
287  genomes will be included in the counts.  genomes will be included in the counts.
# Line 306  Line 326 
326    
327  =head3 ContigCount  =head3 ContigCount
328    
329  C<< my $count = $sprout->ContigCount($genomeID); >>      my $count = $sprout->ContigCount($genomeID);
330    
331  Return the number of contigs for the specified genome ID.  Return the number of contigs for the specified genome ID.
332    
# Line 335  Line 355 
355    
356  =head3 GeneMenu  =head3 GeneMenu
357    
358  C<< my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params); >>      my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params, $selected);
359    
360  Return an HTML select menu of genomes. Each genome will be an option in the menu,  Return an HTML select menu of genomes. Each genome will be an option in the menu,
361  and will be displayed by name with the ID and a contig count attached. The selection  and will be displayed by name with the ID and a contig count attached. The selection
# Line 357  Line 377 
377  Reference to a list of values to be substituted in for the parameter marks in  Reference to a list of values to be substituted in for the parameter marks in
378  the filter string.  the filter string.
379    
380    =item selected (optional)
381    
382    ID of the genome to be initially selected.
383    
384    =item fast (optional)
385    
386    If specified and TRUE, the contig counts will be omitted to improve performance.
387    
388  =item RETURN  =item RETURN
389    
390  Returns an HTML select menu with the specified genomes as selectable options.  Returns an HTML select menu with the specified genomes as selectable options.
# Line 367  Line 395 
395    
396  sub GeneMenu {  sub GeneMenu {
397      # Get the parameters.      # Get the parameters.
398      my ($self, $attributes, $filterString, $params) = @_;      my ($self, $attributes, $filterString, $params, $selected, $fast) = @_;
399        my $slowMode = ! $fast;
400        # Default to nothing selected. This prevents an execution warning if "$selected"
401        # is undefined.
402        $selected = "" unless defined $selected;
403        Trace("Gene Menu called with slow mode \"$slowMode\" and selection \"$selected\".") if T(3);
404      # Start the menu.      # Start the menu.
405      my $retVal = "<select " .      my $retVal = "<select " .
406          join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .          join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .
# Line 375  Line 408 
408      # Get the genomes.      # Get the genomes.
409      my @genomes = $self->GetAll(['Genome'], $filterString, $params, ['Genome(id)',      my @genomes = $self->GetAll(['Genome'], $filterString, $params, ['Genome(id)',
410                                                                       'Genome(genus)',                                                                       'Genome(genus)',
411                                                                       'Genome(species)']);                                                                       'Genome(species)',
412                                                                         'Genome(unique-characterization)']);
413      # Sort them by name.      # Sort them by name.
414      my @sorted = sort { lc("$a->[1] $a->[2]") cmp lc("$b->[1] $b->[2]") } @genomes;      my @sorted = sort { lc("$a->[1] $a->[2]") cmp lc("$b->[1] $b->[2]") } @genomes;
415      # Loop through the genomes, creating the option tags.      # Loop through the genomes, creating the option tags.
416      for my $genomeData (@sorted) {      for my $genomeData (@sorted) {
417          # Get the data for this genome.          # Get the data for this genome.
418          my ($genomeID, $genus, $species) = @{$genomeData};          my ($genomeID, $genus, $species, $strain) = @{$genomeData};
419          # Get the contig count.          # Get the contig count.
420            my $contigInfo = "";
421            if ($slowMode) {
422          my $count = $self->ContigCount($genomeID);          my $count = $self->ContigCount($genomeID);
423          my $counting = ($count == 1 ? "contig" : "contigs");          my $counting = ($count == 1 ? "contig" : "contigs");
424                $contigInfo = "[$count $counting]";
425            }
426            # Find out if we're selected.
427            my $selectOption = ($selected eq $genomeID ? " selected" : "");
428          # Build the option tag.          # Build the option tag.
429          $retVal .= "<option value=\"$genomeID\">$genus $species ($genomeID) [$count $counting]</option>\n";          $retVal .= "<option value=\"$genomeID\"$selectOption>$genus $species $strain ($genomeID)$contigInfo</option>\n";
430      }      }
431      # Close the SELECT tag.      # Close the SELECT tag.
432      $retVal .= "</select>\n";      $retVal .= "</select>\n";
433      # Return the result.      # Return the result.
434      return $retVal;      return $retVal;
435  }  }
436    
437  =head3 Build  =head3 Build
438    
439  C<< $sprout->Build(); >>      $sprout->Build();
440    
441  Build the database. The database will be cleared and the tables re-created from the metadata.  Build the database. The database will be cleared and the tables re-created from the metadata.
442  This method is useful when a database is brand new or when the database definition has  This method is useful when a database is brand new or when the database definition has
# Line 412  Line 453 
453    
454  =head3 Genomes  =head3 Genomes
455    
456  C<< my @genomes = $sprout->Genomes(); >>      my @genomes = $sprout->Genomes();
457    
458  Return a list of all the genome IDs.  Return a list of all the genome IDs.
459    
# Line 429  Line 470 
470    
471  =head3 GenusSpecies  =head3 GenusSpecies
472    
473  C<< my $infoString = $sprout->GenusSpecies($genomeID); >>      my $infoString = $sprout->GenusSpecies($genomeID);
474    
475  Return the genus, species, and unique characterization for a genome.  Return the genus, species, and unique characterization for a genome.
476    
# Line 461  Line 502 
502    
503  =head3 FeaturesOf  =head3 FeaturesOf
504    
505  C<< my @features = $sprout->FeaturesOf($genomeID, $ftype); >>      my @features = $sprout->FeaturesOf($genomeID, $ftype);
506    
507  Return a list of the features relevant to a specified genome.  Return a list of the features relevant to a specified genome.
508    
# Line 506  Line 547 
547    
548  =head3 FeatureLocation  =head3 FeatureLocation
549    
550  C<< my @locations = $sprout->FeatureLocation($featureID); >>      my @locations = $sprout->FeatureLocation($featureID);
551    
552  Return the location of a feature in its genome's contig segments. In a list context, this method  Return the location of a feature in its genome's contig segments. In a list context, this method
553  will return a list of the locations. In a scalar context, it will return the locations as a space-  will return a list of the locations. In a scalar context, it will return the locations as a space-
# Line 535  Line 576 
576  =back  =back
577    
578  =cut  =cut
579  #: Return Type @;  
 #: Return Type $;  
580  sub FeatureLocation {  sub FeatureLocation {
581      # Get the parameters.      # Get the parameters.
582      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
583      # Create a query for the feature locations.      # Get the feature record.
584      my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",      my $object = $self->GetEntity('Feature', $featureID);
585                             [$featureID]);      Confess("Feature $featureID not found.") if ! defined($object);
586        # Get the location string.
587        my $locString = $object->PrimaryValue('Feature(location-string)');
588      # Create the return list.      # Create the return list.
589      my @retVal = ();      my @retVal = split /\s*,\s*/, $locString;
     # Set up the variables used to determine if we have adjacent segments. This initial setup will  
     # not match anything.  
     my ($prevContig, $prevBeg, $prevDir, $prevLen) = ("", 0, "0", 0);  
     # Loop through the query results, creating location specifiers.  
     while (my $location = $query->Fetch()) {  
         # Get the location parameters.  
         my ($contigID, $beg, $dir, $len) = $location->Values(['IsLocatedIn(to-link)',  
             'IsLocatedIn(beg)', 'IsLocatedIn(dir)', 'IsLocatedIn(len)']);  
         # Check to see if we are adjacent to the previous segment.  
         if ($prevContig eq $contigID && $dir eq $prevDir) {  
             # Here the new segment is in the same direction on the same contig. Insure the  
             # new segment's beginning is next to the old segment's end.  
             if ($dir eq "-" && $beg + $len == $prevBeg) {  
                 # Here we're merging two backward blocks, so we keep the new begin point  
                 # and adjust the length.  
                 $len += $prevLen;  
                 # Pop the old segment off. The new one will replace it later.  
                 pop @retVal;  
             } elsif ($dir eq "+" && $beg == $prevBeg + $prevLen) {  
                 # Here we need to merge two forward blocks. Adjust the beginning and  
                 # length values to include both segments.  
                 $beg = $prevBeg;  
                 $len += $prevLen;  
                 # Pop the old segment off. The new one will replace it later.  
                 pop @retVal;  
             }  
         }  
         # Remember this specifier for the adjacent-segment test the next time through.  
         ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);  
         # Compute the initial base pair.  
         my $start = ($dir eq "+" ? $beg : $beg + $len - 1);  
         # Add the specifier to the list.  
         push @retVal, "${contigID}_$start$dir$len";  
     }  
590      # Return the list in the format indicated by the context.      # Return the list in the format indicated by the context.
591      return (wantarray ? @retVal : join(',', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
592  }  }
593    
594  =head3 ParseLocation  =head3 ParseLocation
595    
596  C<< my ($contigID, $start, $dir, $len) = Sprout::ParseLocation($location); >>      my ($contigID, $start, $dir, $len) = Sprout::ParseLocation($location);
597    
598  Split a location specifier into the contig ID, the starting point, the direction, and the  Split a location specifier into the contig ID, the starting point, the direction, and the
599  length.  length.
# Line 604  Line 612 
612  =back  =back
613    
614  =cut  =cut
615  #: Return Type @;  
616  sub ParseLocation {  sub ParseLocation {
617      # Get the parameter. Note that if we're called as an instance method, we ignore      # Get the parameter. Note that if we're called as an instance method, we ignore
618      # the first parameter.      # the first parameter.
# Line 627  Line 635 
635      return ($contigID, $start, $dir, $len);      return ($contigID, $start, $dir, $len);
636  }  }
637    
638    
639    
640  =head3 PointLocation  =head3 PointLocation
641    
642  C<< my $found = Sprout::PointLocation($location, $point); >>      my $found = Sprout::PointLocation($location, $point);
643    
644  Return the offset into the specified location of the specified point on the contig. If  Return the offset into the specified location of the specified point on the contig. If
645  the specified point is before the location, a negative value will be returned. If it is  the specified point is before the location, a negative value will be returned. If it is
# Line 658  Line 668 
668  =back  =back
669    
670  =cut  =cut
671  #: Return Type $;  
672  sub PointLocation {  sub PointLocation {
673      # Get the parameter. Note that if we're called as an instance method, we ignore      # Get the parameter. Note that if we're called as an instance method, we ignore
674      # the first parameter.      # the first parameter.
# Line 681  Line 691 
691    
692  =head3 DNASeq  =head3 DNASeq
693    
694  C<< my $sequence = $sprout->DNASeq(\@locationList); >>      my $sequence = $sprout->DNASeq(\@locationList);
695    
696  This method returns the DNA sequence represented by a list of locations. The list of locations  This method returns the DNA sequence represented by a list of locations. The list of locations
697  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,
# Line 765  Line 775 
775    
776  =head3 AllContigs  =head3 AllContigs
777    
778  C<< my @idList = $sprout->AllContigs($genomeID); >>      my @idList = $sprout->AllContigs($genomeID);
779    
780  Return a list of all the contigs for a genome.  Return a list of all the contigs for a genome.
781    
# Line 793  Line 803 
803      return @retVal;      return @retVal;
804  }  }
805    
806    =head3 GenomeLength
807    
808        my $length = $sprout->GenomeLength($genomeID);
809    
810    Return the length of the specified genome in base pairs.
811    
812    =over 4
813    
814    =item genomeID
815    
816    ID of the genome whose base pair count is desired.
817    
818    =item RETURN
819    
820    Returns the number of base pairs in all the contigs of the specified
821    genome.
822    
823    =back
824    
825    =cut
826    
827    sub GenomeLength {
828        # Get the parameters.
829        my ($self, $genomeID) = @_;
830        # Declare the return variable.
831        my $retVal = 0;
832        # Get the genome's contig sequence lengths.
833        my @lens = $self->GetFlat(['HasContig', 'IsMadeUpOf'], 'HasContig(from-link) = ?',
834                           [$genomeID], 'IsMadeUpOf(len)');
835        # Sum the lengths.
836        map { $retVal += $_ } @lens;
837        # Return the result.
838        return $retVal;
839    }
840    
841    =head3 FeatureCount
842    
843        my $count = $sprout->FeatureCount($genomeID, $type);
844    
845    Return the number of features of the specified type in the specified genome.
846    
847    =over 4
848    
849    =item genomeID
850    
851    ID of the genome whose feature count is desired.
852    
853    =item type
854    
855    Type of feature to count (eg. C<peg>, C<rna>, etc.).
856    
857    =item RETURN
858    
859    Returns the number of features of the specified type for the specified genome.
860    
861    =back
862    
863    =cut
864    
865    sub FeatureCount {
866        # Get the parameters.
867        my ($self, $genomeID, $type) = @_;
868        # Compute the count.
869        my $retVal = $self->GetCount(['HasFeature', 'Feature'],
870                                    "HasFeature(from-link) = ? AND Feature(feature-type) = ?",
871                                    [$genomeID, $type]);
872        # Return the result.
873        return $retVal;
874    }
875    
876    =head3 GenomeAssignments
877    
878        my $fidHash = $sprout->GenomeAssignments($genomeID);
879    
880    Return a list of a genome's assigned features. The return hash will contain each
881    assigned feature of the genome mapped to the text of its most recent functional
882    assignment.
883    
884    =over 4
885    
886    =item genomeID
887    
888    ID of the genome whose functional assignments are desired.
889    
890    =item RETURN
891    
892    Returns a reference to a hash which maps each feature to its most recent
893    functional assignment.
894    
895    =back
896    
897    =cut
898    
899    sub GenomeAssignments {
900        # Get the parameters.
901        my ($self, $genomeID) = @_;
902        # Declare the return variable.
903        my $retVal = {};
904        # Query the genome's features.
905        my $query = $self->Get(['HasFeature', 'Feature'], "HasFeature(from-link) = ?",
906                               [$genomeID]);
907        # Loop through the features.
908        while (my $data = $query->Fetch) {
909            # Get the feature ID and assignment.
910            my ($fid, $assignment) = $data->Values(['Feature(id)', 'Feature(assignment)']);
911            if ($assignment) {
912                $retVal->{$fid} = $assignment;
913            }
914        }
915        # Return the result.
916        return $retVal;
917    }
918    
919  =head3 ContigLength  =head3 ContigLength
920    
921  C<< my $length = $sprout->ContigLength($contigID); >>      my $length = $sprout->ContigLength($contigID);
922    
923  Compute the length of a contig.  Compute the length of a contig.
924    
# Line 834  Line 957 
957    
958  =head3 ClusterPEGs  =head3 ClusterPEGs
959    
960  C<< my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs); >>      my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs);
961    
962  Cluster the PEGs in a list according to the cluster coding scheme of the specified  Cluster the PEGs in a list according to the cluster coding scheme of the specified
963  subsystem. In order for this to work properly, the subsystem object must have  subsystem. In order for this to work properly, the subsystem object must have
964  been used recently to retrieve the PEGs using the B<get_pegs_from_cell> method.  been used recently to retrieve the PEGs using the B<get_pegs_from_cell> or
965  This causes the cluster numbers to be pulled into the subsystem's color hash.  B<get_row> methods. This causes the cluster numbers to be pulled into the
966  If a PEG is not found in the color hash, it will not appear in the output  subsystem's color hash. If a PEG is not found in the color hash, it will not
967  sequence.  appear in the output sequence.
968    
969  =over 4  =over 4
970    
# Line 882  Line 1005 
1005    
1006  =head3 GenesInRegion  =head3 GenesInRegion
1007    
1008  C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>      my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop);
1009    
1010  List the features which overlap a specified region in a contig.  List the features which overlap a specified region in a contig.
1011    
# Line 911  Line 1034 
1034  =back  =back
1035    
1036  =cut  =cut
1037  #: Return Type @@;  
1038  sub GenesInRegion {  sub GenesInRegion {
1039      # Get the parameters.      # Get the parameters.
1040      my ($self, $contigID, $start, $stop) = @_;      my ($self, $contigID, $start, $stop) = @_;
1041      # Get the maximum segment length.      # Get the maximum segment length.
1042      my $maximumSegmentLength = $self->MaxSegment;      my $maximumSegmentLength = $self->MaxSegment;
     # Create a hash to receive the feature list. We use a hash so that we can eliminate  
     # duplicates easily. The hash key will be the feature ID. The value will be a two-element  
     # containing the minimum and maximum offsets. We will use the offsets to sort the results  
     # when we're building the result set.  
     my %featuresFound = ();  
1043      # Prime the values we'll use for the returned beginning and end.      # Prime the values we'll use for the returned beginning and end.
1044      my @initialMinMax = ($self->ContigLength($contigID), 0);      my @initialMinMax = ($self->ContigLength($contigID), 0);
1045      my ($min, $max) = @initialMinMax;      my ($min, $max) = @initialMinMax;
1046      # Create a table of parameters for each query. Each query looks for features travelling in      # Get the overlapping features.
1047        my @featureObjects = $self->GeneDataInRegion($contigID, $start, $stop);
1048        # We'l use this hash to help us track the feature IDs and sort them. The key is the
1049        # feature ID and the value is a [$left,$right] pair indicating the maximum extent
1050        # of the feature's locations.
1051        my %featureMap = ();
1052        # Loop through them to do the begin/end analysis.
1053        for my $featureObject (@featureObjects) {
1054            # Get the feature's location string. This may contain multiple actual locations.
1055            my ($locations, $fid) = $featureObject->Values([qw(Feature(location-string) Feature(id))]);
1056            my @locationSegments = split /\s*,\s*/, $locations;
1057            # Loop through the locations.
1058            for my $locationSegment (@locationSegments) {
1059                # Construct an object for the location.
1060                my $locationObject = BasicLocation->new($locationSegment);
1061                # Merge the current segment's begin and end into the min and max.
1062                my ($left, $right) = ($locationObject->Left, $locationObject->Right);
1063                my ($beg, $end);
1064                if (exists $featureMap{$fid}) {
1065                    ($beg, $end) = @{$featureMap{$fid}};
1066                    $beg = $left if $left < $beg;
1067                    $end = $right if $right > $end;
1068                } else {
1069                    ($beg, $end) = ($left, $right);
1070                }
1071                $min = $beg if $beg < $min;
1072                $max = $end if $end > $max;
1073                # Store the feature's new extent back into the hash table.
1074                $featureMap{$fid} = [$beg, $end];
1075            }
1076        }
1077        # Now we must compute the list of the IDs for the features found. We start with a list
1078        # of midpoints / feature ID pairs. (It's not really a midpoint, it's twice the midpoint,
1079        # but the result of the sort will be the same.)
1080        my @list = map { [$featureMap{$_}->[0] + $featureMap{$_}->[1], $_] } keys %featureMap;
1081        # Now we sort by midpoint and yank out the feature IDs.
1082        my @retVal = map { $_->[1] } sort { $a->[0] <=> $b->[0] } @list;
1083        # Return it along with the min and max.
1084        return (\@retVal, $min, $max);
1085    }
1086    
1087    =head3 GeneDataInRegion
1088    
1089        my @featureList = $sprout->GenesInRegion($contigID, $start, $stop);
1090    
1091    List the features which overlap a specified region in a contig.
1092    
1093    =over 4
1094    
1095    =item contigID
1096    
1097    ID of the contig containing the region of interest.
1098    
1099    =item start
1100    
1101    Offset of the first residue in the region of interest.
1102    
1103    =item stop
1104    
1105    Offset of the last residue in the region of interest.
1106    
1107    =item RETURN
1108    
1109    Returns a list of B<ERDBObjects> for the desired features. Each object will
1110    contain a B<Feature> record.
1111    
1112    =back
1113    
1114    =cut
1115    
1116    sub GeneDataInRegion {
1117        # Get the parameters.
1118        my ($self, $contigID, $start, $stop) = @_;
1119        # Get the maximum segment length.
1120        my $maximumSegmentLength = $self->MaxSegment;
1121        # Create a hash to receive the feature list. We use a hash so that we can eliminate
1122        # duplicates easily. The hash key will be the feature ID. The value will be the feature's
1123        # ERDBObject from the query.
1124        my %featuresFound = ();
1125        # Create a table of parameters for the queries. Each query looks for features travelling in
1126      # a particular direction. The query parameters include the contig ID, the feature direction,      # a particular direction. The query parameters include the contig ID, the feature direction,
1127      # the lowest possible start position, and the highest possible start position. This works      # the lowest possible start position, and the highest possible start position. This works
1128      # because each feature segment length must be no greater than the maximum segment length.      # because each feature segment length must be no greater than the maximum segment length.
# Line 934  Line 1131 
1131      # Loop through the query parameters.      # Loop through the query parameters.
1132      for my $parms (values %queryParms) {      for my $parms (values %queryParms) {
1133          # Create the query.          # Create the query.
1134          my $query = $self->Get(['IsLocatedIn'],          my $query = $self->Get([qw(Feature IsLocatedIn)],
1135              "IsLocatedIn(to-link)= ? AND IsLocatedIn(dir) = ? AND IsLocatedIn(beg) >= ? AND IsLocatedIn(beg) <= ?",              "IsLocatedIn(to-link)= ? AND IsLocatedIn(dir) = ? AND IsLocatedIn(beg) >= ? AND IsLocatedIn(beg) <= ?",
1136              $parms);              $parms);
1137          # Loop through the feature segments found.          # Loop through the feature segments found.
1138          while (my $segment = $query->Fetch) {          while (my $segment = $query->Fetch) {
1139              # Get the data about this segment.              # Get the data about this segment.
1140              my ($featureID, $dir, $beg, $len) = $segment->Values(['IsLocatedIn(from-link)',              my ($featureID, $contig, $dir, $beg, $len) = $segment->Values([qw(IsLocatedIn(from-link)
1141                  'IsLocatedIn(dir)', 'IsLocatedIn(beg)', 'IsLocatedIn(len)']);                  IsLocatedIn(to-link) IsLocatedIn(dir) IsLocatedIn(beg) IsLocatedIn(len))]);
1142              # Determine if this feature actually overlaps the region. The query insures that              # Determine if this feature segment actually overlaps the region. The query insures that
1143              # this will be the case if the segment is the maximum length, so to fine-tune              # this will be the case if the segment is the maximum length, so to fine-tune
1144              # the results we insure that the inequality from the query holds using the actual              # the results we insure that the inequality from the query holds using the actual
1145              # length.              # length.
1146              my ($found, $end) = (0, 0);              my $loc = BasicLocation->new($contig, $beg, $dir, $len);
1147              if ($dir eq '+') {              my $found = $loc->Overlap($start, $stop);
                 $end = $beg + $len;  
                 if ($end >= $start) {  
                     # Denote we found a useful feature.  
                     $found = 1;  
                 }  
             } elsif ($dir eq '-') {  
                 # Note we switch things around so that the beginning is to the left of the  
                 # ending.  
                 ($beg, $end) = ($beg - $len, $beg);  
                 if ($beg <= $stop) {  
                     # Denote we found a useful feature.  
                     $found = 1;  
                 }  
             }  
1148              if ($found) {              if ($found) {
1149                  # Here we need to record the feature and update the minima and maxima. First,                  # Save this feature in the result list.
1150                  # get the current entry for the specified feature.                  $featuresFound{$featureID} = $segment;
                 my ($loc1, $loc2) = (exists $featuresFound{$featureID} ? @{$featuresFound{$featureID}} :  
                                      @initialMinMax);  
                 # Merge the current segment's begin and end into the feature begin and end and the  
                 # global min and max.  
                 if ($beg < $loc1) {  
                     $loc1 = $beg;  
                     $min = $beg if $beg < $min;  
                 }  
                 if ($end > $loc2) {  
                     $loc2 = $end;  
                     $max = $end if $end > $max;  
                 }  
                 # Store the entry back into the hash table.  
                 $featuresFound{$featureID} = [$loc1, $loc2];  
1151              }              }
1152          }          }
1153      }      }
1154      # Now we must compute the list of the IDs for the features found. We start with a list      # Return the ERDB objects for the features found.
1155      # of midpoints / feature ID pairs. (It's not really a midpoint, it's twice the midpoint,      return values %featuresFound;
     # but the result of the sort will be the same.)  
     my @list = map { [$featuresFound{$_}->[0] + $featuresFound{$_}->[1], $_] } keys %featuresFound;  
     # Now we sort by midpoint and yank out the feature IDs.  
     my @retVal = map { $_->[1] } sort { $a->[0] <=> $b->[0] } @list;  
     # Return it along with the min and max.  
     return (\@retVal, $min, $max);  
1156  }  }
1157    
1158  =head3 FType  =head3 FType
1159    
1160  C<< my $ftype = $sprout->FType($featureID); >>      my $ftype = $sprout->FType($featureID);
1161    
1162  Return the type of a feature.  Return the type of a feature.
1163    
# Line 1024  Line 1187 
1187    
1188  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1189    
1190  C<< my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag); >>      my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag);
1191    
1192  Return the annotations of a feature.  Return the annotations of a feature.
1193    
# Line 1087  Line 1250 
1250    
1251  =head3 AllFunctionsOf  =head3 AllFunctionsOf
1252    
1253  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>      my %functions = $sprout->AllFunctionsOf($featureID);
1254    
1255  Return all of the functional assignments for a particular feature. The data is returned as a  Return all of the functional assignments for a particular feature. The data is returned as a
1256  hash of functional assignments to user IDs. A functional assignment is a type of annotation,  hash of functional assignments to user IDs. A functional assignment is a type of annotation,
# Line 1142  Line 1305 
1305    
1306  =head3 FunctionOf  =head3 FunctionOf
1307    
1308  C<< my $functionText = $sprout->FunctionOf($featureID, $userID); >>      my $functionText = $sprout->FunctionOf($featureID, $userID);
1309    
1310  Return the most recently-determined functional assignment of a particular feature.  Return the most recently-determined functional assignment of a particular feature.
1311    
1312  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
1313  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 the functional
1314  assignment is a type of annotation. The format of an assignment is described in  assignment is taken from the B<Feature> or C<Annotation> table, depending.
 L</ParseAssignment>. Its worth noting that we cannot filter on the content of the  
 annotation itself because it's a text field; however, this is not a big problem because  
 most features only have a small number of annotations.  
1315    
1316  Each user has an associated list of trusted users. The assignment returned will be the most  Each user has an associated list of trusted users. The assignment returned will be the most
1317  recent one by at least one of the trusted users. If no trusted user list is available, then  recent one by at least one of the trusted users. If no trusted user list is available, then
# Line 1170  Line 1330 
1330    
1331  =item userID (optional)  =item userID (optional)
1332    
1333  ID of the user whose function determination is desired. If omitted, only the latest  ID of the user whose function determination is desired. If omitted, the primary
1334  C<FIG> assignment will be returned.  functional assignment in the B<Feature> table will be returned.
1335    
1336  =item RETURN  =item RETURN
1337    
# Line 1188  Line 1348 
1348      my $retVal;      my $retVal;
1349      # Determine the ID type.      # Determine the ID type.
1350      if ($featureID =~ m/^fig\|/) {      if ($featureID =~ m/^fig\|/) {
1351          # Here we have a FIG feature ID. We must build the list of trusted          # Here we have a FIG feature ID.
1352          # users.          if (!$userID) {
1353                # Use the primary assignment.
1354                ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(assignment)']);
1355            } else {
1356                # We must build the list of trusted users.
1357          my %trusteeTable = ();          my %trusteeTable = ();
1358          # Check the user ID.          # Check the user ID.
1359          if (!$userID) {          if (!$userID) {
# Line 1232  Line 1396 
1396                  }                  }
1397              }              }
1398          }          }
1399            }
1400      } else {      } else {
1401          # Here we have a non-FIG feature ID. In this case the user ID does not          # Here we have a non-FIG feature ID. In this case the user ID does not
1402          # matter. We simply get the information from the External Alias Function          # matter. We simply get the information from the External Alias Function
# Line 1244  Line 1409 
1409    
1410  =head3 FunctionsOf  =head3 FunctionsOf
1411    
1412  C<< my @functionList = $sprout->FunctionOf($featureID, $userID); >>      my @functionList = $sprout->FunctionOf($featureID, $userID);
1413    
1414  Return the functional assignments of a particular feature.  Return the functional assignments of a particular feature.
1415    
# Line 1316  Line 1481 
1481    
1482  =head3 BBHList  =head3 BBHList
1483    
1484  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>      my $bbhHash = $sprout->BBHList($genomeID, \@featureList);
1485    
1486  Return a hash mapping the features in a specified list to their bidirectional best hits  Return a hash mapping the features in a specified list to their bidirectional best hits
1487  on a specified target genome.  on a specified target genome.
# Line 1347  Line 1512 
1512      my %retVal = ();      my %retVal = ();
1513      # Loop through the incoming features.      # Loop through the incoming features.
1514      for my $featureID (@{$featureList}) {      for my $featureID (@{$featureList}) {
1515          # Create a query to get the feature's best hit.          # Ask the server for the feature's best hit.
1516          my $query = $self->Get(['IsBidirectionalBestHitOf'],          my @bbhData = FIGRules::BBHData($featureID);
                                "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",  
                                [$featureID, $genomeID]);  
1517          # Peel off the BBHs found.          # Peel off the BBHs found.
1518          my @found = ();          my @found = ();
1519          while (my $bbh = $query->Fetch) {          for my $bbh (@bbhData) {
1520              push @found, $bbh->Value('IsBidirectionalBestHitOf(to-link)');              my $fid = $bbh->[0];
1521                my $bbGenome = $self->GenomeOf($fid);
1522                if ($bbGenome eq $genomeID) {
1523                    push @found, $fid;
1524                }
1525          }          }
1526          $retVal{$featureID} = \@found;          $retVal{$featureID} = \@found;
1527      }      }
# Line 1364  Line 1531 
1531    
1532  =head3 SimList  =head3 SimList
1533    
1534  C<< my %similarities = $sprout->SimList($featureID, $count); >>      my %similarities = $sprout->SimList($featureID, $count);
1535    
1536  Return a list of the similarities to the specified feature.  Return a list of the similarities to the specified feature.
1537    
1538  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.  
1539    
1540  =over 4  =over 4
1541    
# Line 1389  Line 1555 
1555      # Get the parameters.      # Get the parameters.
1556      my ($self, $featureID, $count) = @_;      my ($self, $featureID, $count) = @_;
1557      # Ask for the best hits.      # Ask for the best hits.
1558      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);  
1559      # Create the return value.      # Create the return value.
1560      my %retVal = ();      my %retVal = ();
1561      for my $tuple (@lists) {      for my $tuple (@lists) {
# Line 1402  Line 1565 
1565      return %retVal;      return %retVal;
1566  }  }
1567    
   
   
1568  =head3 IsComplete  =head3 IsComplete
1569    
1570  C<< my $flag = $sprout->IsComplete($genomeID); >>      my $flag = $sprout->IsComplete($genomeID);
1571    
1572  Return TRUE if the specified genome is complete, else FALSE.  Return TRUE if the specified genome is complete, else FALSE.
1573    
# Line 1434  Line 1595 
1595      my $genomeData = $self->GetEntity('Genome', $genomeID);      my $genomeData = $self->GetEntity('Genome', $genomeID);
1596      if ($genomeData) {      if ($genomeData) {
1597          # The genome exists, so get the completeness flag.          # The genome exists, so get the completeness flag.
1598          ($retVal) = $genomeData->Value('Genome(complete)');          $retVal = $genomeData->PrimaryValue('Genome(complete)');
1599      }      }
1600      # Return the result.      # Return the result.
1601      return $retVal;      return $retVal;
# Line 1442  Line 1603 
1603    
1604  =head3 FeatureAliases  =head3 FeatureAliases
1605    
1606  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>      my @aliasList = $sprout->FeatureAliases($featureID);
1607    
1608  Return a list of the aliases for a specified feature.  Return a list of the aliases for a specified feature.
1609    
# Line 1465  Line 1626 
1626      # Get the parameters.      # Get the parameters.
1627      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1628      # Get the desired feature's aliases      # Get the desired feature's aliases
1629      my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);      my @retVal = $self->GetFlat(['IsAliasOf'], "IsAliasOf(to-link) = ?", [$featureID], 'IsAliasOf(from-link)');
1630      # Return the result.      # Return the result.
1631      return @retVal;      return @retVal;
1632  }  }
1633    
1634  =head3 GenomeOf  =head3 GenomeOf
1635    
1636  C<< my $genomeID = $sprout->GenomeOf($featureID); >>      my $genomeID = $sprout->GenomeOf($featureID);
1637    
1638  Return the genome that contains a specified feature or contig.  Return the genome that contains a specified feature or contig.
1639    
# Line 1494  Line 1655 
1655  sub GenomeOf {  sub GenomeOf {
1656      # Get the parameters.      # Get the parameters.
1657      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
     # Create a query to find the genome associated with the incoming ID.  
     my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ? OR HasContig(to-link) = ?",  
                            [$featureID, $featureID]);  
1658      # Declare the return value.      # Declare the return value.
1659      my $retVal;      my $retVal;
1660      # Get the genome ID.      # Parse the genome ID from the feature ID.
1661      if (my $relationship = $query->Fetch()) {      if ($featureID =~ /^fig\|(\d+\.\d+)/) {
1662          ($retVal) = $relationship->Value('HasContig(from-link)');          $retVal = $1;
1663        } else {
1664            Confess("Invalid feature ID $featureID.");
1665      }      }
1666      # Return the value found.      # Return the value found.
1667      return $retVal;      return $retVal;
# Line 1509  Line 1669 
1669    
1670  =head3 CoupledFeatures  =head3 CoupledFeatures
1671    
1672  C<< my %coupleHash = $sprout->CoupledFeatures($featureID); >>      my %coupleHash = $sprout->CoupledFeatures($featureID);
1673    
1674  Return the features functionally coupled with a specified feature. Features are considered  Return the features functionally coupled with a specified feature. Features are considered
1675  functionally coupled if they tend to be clustered on the same chromosome.  functionally coupled if they tend to be clustered on the same chromosome.
# Line 1531  Line 1691 
1691  sub CoupledFeatures {  sub CoupledFeatures {
1692      # Get the parameters.      # Get the parameters.
1693      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1694      # Create a query to retrieve the functionally-coupled features.      # Ask the coupling server for the data.
1695      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],      Trace("Looking for features coupled to $featureID.") if T(coupling => 3);
1696                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);      my @rawPairs = FIGRules::NetCouplingData('coupled_to', id1 => $featureID);
1697      # This value will be set to TRUE if we find at least one coupled feature.      Trace(scalar(@rawPairs) . " couplings returned.") if T(coupling => 3);
1698      my $found = 0;      # Form them into a hash.
     # Create the return hash.  
1699      my %retVal = ();      my %retVal = ();
1700      # Retrieve the relationship records and store them in the hash.      for my $pair (@rawPairs) {
1701      while (my $clustering = $query->Fetch()) {          # Get the feature ID and score.
1702          # Get the ID and score of the coupling.          my ($featureID2, $score) = @{$pair};
1703          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',          # Only proceed if the feature is in NMPDR.
1704                                                          'Coupling(score)']);          if ($self->_CheckFeature($featureID2)) {
1705          # Get the other feature that participates in the coupling.              $retVal{$featureID2} = $score;
1706          my ($otherFeatureID) = $self->GetFlat(['ParticipatesInCoupling'],          }
                                            "ParticipatesInCoupling(to-link) = ? AND ParticipatesInCoupling(from-link) <> ?",  
                                            [$couplingID, $featureID], 'ParticipatesInCoupling(to-link)');  
         # Attach the other feature's score to its ID.  
         $retVal{$otherFeatureID} = $score;  
         $found = 1;  
1707      }      }
1708      # Functional coupling is reflexive. If we found at least one coupled feature, we must add      # Functional coupling is reflexive. If we found at least one coupled feature, we must add
1709      # the incoming feature as well.      # the incoming feature as well.
1710      if ($found) {      if (keys %retVal) {
1711          $retVal{$featureID} = 9999;          $retVal{$featureID} = 9999;
1712      }      }
1713      # Return the hash.      # Return the hash.
# Line 1562  Line 1716 
1716    
1717  =head3 CouplingEvidence  =head3 CouplingEvidence
1718    
1719  C<< my @evidence = $sprout->CouplingEvidence($peg1, $peg2); >>      my @evidence = $sprout->CouplingEvidence($peg1, $peg2);
1720    
1721  Return the evidence for a functional coupling.  Return the evidence for a functional coupling.
1722    
# Line 1610  Line 1764 
1764      my ($self, $peg1, $peg2) = @_;      my ($self, $peg1, $peg2) = @_;
1765      # Declare the return variable.      # Declare the return variable.
1766      my @retVal = ();      my @retVal = ();
1767      # Our first task is to find out the nature of the coupling: whether or not      # Get the coupling and evidence data.
1768      # it exists, its score, and whether the features are stored in the same      my @rawData = FIGRules::NetCouplingData('coupling_evidence', id1 => $peg1, id2 => $peg2);
1769      # order as the ones coming in.      # Loop through the raw data, saving the ones that are in NMPDR genomes.
1770      my ($couplingID, $inverted, $score) = $self->GetCoupling($peg1, $peg2);      for my $rawTuple (@rawData) {
1771      # Only proceed if a coupling exists.          if ($self->_CheckFeature($rawTuple->[0]) && $self->_CheckFeature($rawTuple->[1])) {
1772      if ($couplingID) {              push @retVal, $rawTuple;
1773          # Determine the ordering to place on the evidence items. If we're          }
         # inverted, we want to see feature 2 before feature 1 (descending); otherwise,  
         # we want feature 1 before feature 2 (normal).  
         Trace("Coupling evidence for ($peg1, $peg2) with inversion flag $inverted.") if T(Coupling => 4);  
         my $ordering = ($inverted ? "DESC" : "");  
         # Get the coupling evidence.  
         my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],  
                                           "IsEvidencedBy(from-link) = ? ORDER BY PCH(id), UsesAsEvidence(pos) $ordering",  
                                           [$couplingID],  
                                           ['PCH(used)', 'UsesAsEvidence(to-link)']);  
         # Loop through the evidence items. Each piece of evidence is represented by two  
         # positions in the evidence list, one for each feature on the other side of the  
         # evidence link. If at some point we want to generalize to couplings with  
         # more than two positions, this section of code will need to be re-done.  
         while (@evidenceList > 0) {  
             my $peg1Data = shift @evidenceList;  
             my $peg2Data = shift @evidenceList;  
             Trace("Peg 1 is " . $peg1Data->[1] . " and Peg 2 is " . $peg2Data->[1] . ".") if T(Coupling => 4);  
             push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];  
         }  
         Trace("Last index in evidence result is is $#retVal.") if T(Coupling => 4);  
1774      }      }
1775      # Return the result.      # Return the result.
1776      return @retVal;      return @retVal;
1777  }  }
1778    
1779  =head3 GetCoupling  =head3 GetSynonymGroup
   
 C<< my ($couplingID, $inverted, $score) = $sprout->GetCoupling($peg1, $peg2); >>  
   
 Return the coupling (if any) for the specified pair of PEGs. If a coupling  
 exists, we return the coupling ID along with an indicator of whether the  
 coupling is stored as C<(>I<$peg1>C<, >I<$peg2>C<)> or C<(>I<$peg2>C<, >I<$peg1>C<)>.  
 In the second case, we say the coupling is I<inverted>. The importance of an  
 inverted coupling is that the PEGs in the evidence will appear in reverse order.  
1780    
1781  =over 4      my $id = $sprout->GetSynonymGroup($fid);
1782    
1783  =item peg1  Return the synonym group name for the specified feature.
1784    
1785  ID of the feature of interest.  =over 4
1786    
1787  =item peg2  =item fid
1788    
1789  ID of the potentially coupled feature.  ID of the feature whose synonym group is desired.
1790    
1791  =item RETURN  =item RETURN
1792    
1793  Returns a three-element list. The first element contains the database ID of  The name of the synonym group to which the feature belongs. If the feature does
1794  the coupling. The second element is FALSE if the coupling is stored in the  not belong to a synonym group, the feature ID itself is returned.
 database in the caller specified order and TRUE if it is stored in the  
 inverted order. The third element is the coupling's score. If the coupling  
 does not exist, all three list elements will be C<undef>.  
1795    
1796  =back  =back
1797    
1798  =cut  =cut
1799  #: Return Type $%@;  
1800  sub GetCoupling {  sub GetSynonymGroup {
1801      # Get the parameters.      # Get the parameters.
1802      my ($self, $peg1, $peg2) = @_;      my ($self, $fid) = @_;
1803      # Declare the return values. We'll start with the coupling ID and undefine the      # Declare the return variable.
1804      # flag and score until we have more information.      my $retVal;
1805      my ($retVal, $inverted, $score) = (CouplingID($peg1, $peg2), undef, undef);      # Find the synonym group.
1806      # Find the coupling data.      my @groups = $self->GetFlat(['IsSynonymGroupFor'], "IsSynonymGroupFor(to-link) = ?",
1807      my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],                                     [$fid], 'IsSynonymGroupFor(from-link)');
                                  "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",  
                                  [$retVal], ["ParticipatesInCoupling(from-link)", "Coupling(score)"]);  
1808      # Check to see if we found anything.      # Check to see if we found anything.
1809      if (!@pegs) {      if (@groups) {
1810          Trace("No coupling found.") if T(Coupling => 4);          $retVal = $groups[0];
         # No coupling, so undefine the return value.  
         $retVal = undef;  
1811      } else {      } else {
1812          # We have a coupling! Get the score and check for inversion.          $retVal = $fid;
         $score = $pegs[0]->[1];  
         my $firstFound = $pegs[0]->[0];  
         $inverted = ($firstFound ne $peg1);  
         Trace("Coupling score is $score. First peg is $firstFound, peg 1 is $peg1.") if T(Coupling => 4);  
1813      }      }
1814      # Return the result.      # Return the result.
1815      return ($retVal, $inverted, $score);      return $retVal;
1816  }  }
1817    
1818  =head3 CouplingID  =head3 GetBoundaries
1819    
1820  C<< my $couplingID = Sprout::CouplingID($peg1, $peg2); >>      my ($contig, $beg, $end) = $sprout->GetBoundaries(@locList);
1821    
1822  Return the coupling ID for a pair of feature IDs.  Determine the begin and end boundaries for the locations in a list. All of the
1823    locations must belong to the same contig and have mostly the same direction in
1824  The coupling ID is currently computed by joining the feature IDs in  order for this method to produce a meaningful result. The resulting
1825  sorted order with a space. Client modules (that is, modules which  begin/end pair will contain all of the bases in any of the locations.
 use Sprout) should not, however, count on this always being the  
 case. This method provides a way for abstracting the concept of a  
 coupling ID. All that we know for sure about it is that it can be  
 generated easily from the feature IDs and the order of the IDs  
 in the parameter list does not matter (i.e. C<CouplingID("a1", "b1")>  
 will have the same value as C<CouplingID("b1", "a1")>.  
1826    
1827  =over 4  =over 4
1828    
1829  =item peg1  =item locList
   
 First feature of interest.  
   
 =item peg2  
1830    
1831  Second feature of interest.  List of locations to process.
1832    
1833  =item RETURN  =item RETURN
1834    
1835  Returns the ID that would be used to represent a functional coupling of  Returns a 3-tuple consisting of the contig ID, the beginning boundary,
1836  the two specified PEGs.  and the ending boundary. The beginning boundary will be left of the
1837    end for mostly-forward locations and right of the end for mostly-backward
1838    locations.
1839    
1840  =back  =back
1841    
1842  =cut  =cut
1843  #: Return Type $;  
1844  sub CouplingID {  sub GetBoundaries {
1845      return join " ", sort @_;      # Get the parameters.
1846        my ($self, @locList) = @_;
1847        # Set up the counters used to determine the most popular direction.
1848        my %counts = ( '+' => 0, '-' => 0 );
1849        # Get the last location and parse it.
1850        my $locObject = BasicLocation->new(pop @locList);
1851        # Prime the loop with its data.
1852        my ($contig, $beg, $end) = ($locObject->Contig, $locObject->Left, $locObject->Right);
1853        # Count its direction.
1854        $counts{$locObject->Dir}++;
1855        # Loop through the remaining locations. Note that in most situations, this loop
1856        # will not iterate at all, because most of the time we will be dealing with a
1857        # singleton list.
1858        for my $loc (@locList) {
1859            # Create a location object.
1860            my $locObject = BasicLocation->new($loc);
1861            # Count the direction.
1862            $counts{$locObject->Dir}++;
1863            # Get the left end and the right end.
1864            my $left = $locObject->Left;
1865            my $right = $locObject->Right;
1866            # Merge them into the return variables.
1867            if ($left < $beg) {
1868                $beg = $left;
1869            }
1870            if ($right > $end) {
1871                $end = $right;
1872            }
1873        }
1874        # If the most common direction is reverse, flip the begin and end markers.
1875        if ($counts{'-'} > $counts{'+'}) {
1876            ($beg, $end) = ($end, $beg);
1877        }
1878        # Return the result.
1879        return ($contig, $beg, $end);
1880  }  }
1881    
1882  =head3 ReadFasta  =head3 ReadFasta
1883    
1884  C<< my %sequenceData = Sprout::ReadFasta($fileName, $prefix); >>      my %sequenceData = Sprout::ReadFasta($fileName, $prefix);
1885    
1886  Read sequence data from a FASTA-format file. Each sequence in a FASTA file is represented by  Read sequence data from a FASTA-format file. Each sequence in a FASTA file is represented by
1887  one or more lines of data. The first line begins with a > character and contains an ID.  one or more lines of data. The first line begins with a > character and contains an ID.
# Line 1806  Line 1947 
1947    
1948  =head3 FormatLocations  =head3 FormatLocations
1949    
1950  C<< my @locations = $sprout->FormatLocations($prefix, \@locations, $oldFormat); >>      my @locations = $sprout->FormatLocations($prefix, \@locations, $oldFormat);
1951    
1952  Insure that a list of feature locations is in the Sprout format. The Sprout feature location  Insure that a list of feature locations is in the Sprout format. The Sprout feature location
1953  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward
# Line 1871  Line 2012 
2012    
2013  =head3 DumpData  =head3 DumpData
2014    
2015  C<< $sprout->DumpData(); >>      $sprout->DumpData();
2016    
2017  Dump all the tables to tab-delimited DTX files. The files will be stored in the data directory.  Dump all the tables to tab-delimited DTX files. The files will be stored in the data directory.
2018    
# Line 1888  Line 2029 
2029    
2030  =head3 XMLFileName  =head3 XMLFileName
2031    
2032  C<< my $fileName = $sprout->XMLFileName(); >>      my $fileName = $sprout->XMLFileName();
2033    
2034  Return the name of this database's XML definition file.  Return the name of this database's XML definition file.
2035    
# Line 1899  Line 2040 
2040      return $self->{_xmlName};      return $self->{_xmlName};
2041  }  }
2042    
2043    =head3 GetGenomeNameData
2044    
2045        my ($genus, $species, $strain) = $sprout->GenomeNameData($genomeID);
2046    
2047    Return the genus, species, and unique characterization for a genome. This
2048    is similar to L</GenusSpecies>, with the exception that it returns the
2049    values in three seperate fields.
2050    
2051    =over 4
2052    
2053    =item genomeID
2054    
2055    ID of the genome whose name data is desired.
2056    
2057    =item RETURN
2058    
2059    Returns a three-element list, consisting of the genus, species, and strain
2060    of the specified genome. If the genome is not found, an error occurs.
2061    
2062    =back
2063    
2064    =cut
2065    
2066    sub GetGenomeNameData {
2067        # Get the parameters.
2068        my ($self, $genomeID) = @_;
2069        # Get the desired values.
2070        my ($genus, $species, $strain) = $self->GetEntityValues('Genome', $genomeID =>
2071                                                                [qw(Genome(genus) Genome(species) Genome(unique-characterization))]);
2072        # Throw an error if they were not found.
2073        if (! defined $genus) {
2074            Confess("Genome $genomeID not found in database.");
2075        }
2076        # Return the results.
2077        return ($genus, $species, $strain);
2078    }
2079    
2080    =head3 GetGenomeByNameData
2081    
2082        my @genomes = $sprout->GetGenomeByNameData($genus, $species, $strain);
2083    
2084    Return a list of the IDs of the genomes with the specified genus,
2085    species, and strain. In almost every case, there will be either zero or
2086    one IDs returned; however, two or more IDs could be returned if there are
2087    multiple versions of the genome in the database.
2088    
2089    =over 4
2090    
2091    =item genus
2092    
2093    Genus of the desired genome.
2094    
2095    =item species
2096    
2097    Species of the desired genome.
2098    
2099    =item strain
2100    
2101    Strain (unique characterization) of the desired genome. This may be an empty
2102    string, in which case it is presumed that the desired genome has no strain
2103    specified.
2104    
2105    =item RETURN
2106    
2107    Returns a list of the IDs of the genomes having the specified genus, species, and
2108    strain.
2109    
2110    =back
2111    
2112    =cut
2113    
2114    sub GetGenomeByNameData {
2115        # Get the parameters.
2116        my ($self, $genus, $species, $strain) = @_;
2117        # Try to find the genomes.
2118        my @retVal = $self->GetFlat(['Genome'], "Genome(genus) = ? AND Genome(species) = ? AND Genome(unique-characterization) = ?",
2119                                    [$genus, $species, $strain], 'Genome(id)');
2120        # Return the result.
2121        return @retVal;
2122    }
2123    
2124  =head3 Insert  =head3 Insert
2125    
2126  C<< $sprout->Insert($objectType, \%fieldHash); >>      $sprout->Insert($objectType, \%fieldHash);
2127    
2128  Insert an entity or relationship instance into the database. The entity or relationship of interest  Insert an entity or relationship instance into the database. The entity or relationship of interest
2129  is defined by a type name and then a hash of field names to values. Field values in the primary  is defined by a type name and then a hash of field names to values. Field values in the primary
# Line 1910  Line 2132 
2132  list references. For example, the following line inserts an inactive PEG feature named  list references. For example, the following line inserts an inactive PEG feature named
2133  C<fig|188.1.peg.1> with aliases C<ZP_00210270.1> and C<gi|46206278>.  C<fig|188.1.peg.1> with aliases C<ZP_00210270.1> and C<gi|46206278>.
2134    
2135  C<< $sprout->Insert('Feature', { id => 'fig|188.1.peg.1', active => 0, feature-type => 'peg', alias => ['ZP_00210270.1', 'gi|46206278']}); >>      $sprout->Insert('Feature', { id => 'fig|188.1.peg.1', active => 0, feature-type => 'peg', alias => ['ZP_00210270.1', 'gi|46206278']});
2136    
2137  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and
2138  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.
2139    
2140  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence => 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>      $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence => 'http://seedu.uchicago.edu/query.cgi?article_id=142'});
2141    
2142  =over 4  =over 4
2143    
# Line 1940  Line 2162 
2162    
2163  =head3 Annotate  =head3 Annotate
2164    
2165  C<< my $ok = $sprout->Annotate($fid, $timestamp, $user, $text); >>      my $ok = $sprout->Annotate($fid, $timestamp, $user, $text);
2166    
2167  Annotate a feature. This inserts an Annotation record into the database and links it to the  Annotate a feature. This inserts an Annotation record into the database and links it to the
2168  specified feature and user.  specified feature and user.
# Line 1994  Line 2216 
2216    
2217  =head3 AssignFunction  =head3 AssignFunction
2218    
2219  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function, $assigningUser); >>      my $ok = $sprout->AssignFunction($featureID, $user, $function, $assigningUser);
2220    
2221  This method assigns a function to a feature. Functions are a special type of annotation. The general  This method assigns a function to a feature. Functions are a special type of annotation. The general
2222  format is described in L</ParseAssignment>.  format is described in L</ParseAssignment>.
# Line 2054  Line 2276 
2276    
2277  =head3 FeaturesByAlias  =head3 FeaturesByAlias
2278    
2279  C<< my @features = $sprout->FeaturesByAlias($alias); >>      my @features = $sprout->FeaturesByAlias($alias);
2280    
2281  Returns a list of features with the specified alias. The alias is parsed to determine  Returns a list of features with the specified alias. The alias is parsed to determine
2282  the type of the alias. A string of digits is a GenBack ID and a string of exactly 6  the type of the alias. A string of digits is a GenBack ID and a string of exactly 6
# Line 2088  Line 2310 
2310          push @retVal, $mappedAlias;          push @retVal, $mappedAlias;
2311      } else {      } else {
2312          # Here we have a non-FIG alias. Get the features with the normalized alias.          # Here we have a non-FIG alias. Get the features with the normalized alias.
2313          @retVal = $self->GetFlat(['Feature'], 'Feature(alias) = ?', [$mappedAlias], 'Feature(id)');          @retVal = $self->GetFlat(['IsAliasOf'], 'IsAliasOf(from-link) = ?', [$mappedAlias], 'IsAliasOf(to-link)');
2314      }      }
2315      # Return the result.      # Return the result.
2316      return @retVal;      return @retVal;
2317  }  }
2318    
2319  =head3 Exists  =head3 FeatureTranslation
2320    
2321  C<< my $found = $sprout->Exists($entityName, $entityID); >>      my $translation = $sprout->FeatureTranslation($featureID);
2322    
2323  Return TRUE if an entity exists, else FALSE.  Return the translation of a feature.
2324    
2325  =over 4  =over 4
2326    
2327  =item entityName  =item featureID
   
 Name of the entity type (e.g. C<Feature>) relevant to the existence check.  
   
 =item entityID  
2328    
2329  ID of the entity instance whose existence is to be checked.  ID of the feature whose translation is desired
2330    
2331  =item RETURN  =item RETURN
2332    
2333  Returns TRUE if the entity instance exists, else FALSE.  Returns the translation of the specified feature.
2334    
2335  =back  =back
2336    
2337  =cut  =cut
2338  #: Return Type $;  #: Return Type $;
2339  sub Exists {  sub FeatureTranslation {
2340      # Get the parameters.      # Get the parameters.
2341      my ($self, $entityName, $entityID) = @_;      my ($self, $featureID) = @_;
2342      # Check for the entity instance.      # Get the specified feature's translation.
2343      Trace("Checking existence of $entityName with ID=$entityID.") if T(4);      my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);
     my $testInstance = $self->GetEntity($entityName, $entityID);  
     # Return an existence indicator.  
     my $retVal = ($testInstance ? 1 : 0);  
2344      return $retVal;      return $retVal;
2345  }  }
2346    
2347  =head3 FeatureTranslation  =head3 Taxonomy
2348    
2349  C<< my $translation = $sprout->FeatureTranslation($featureID); >>      my @taxonomyList = $sprout->Taxonomy($genome);
   
 Return the translation of a feature.  
   
 =over 4  
   
 =item featureID  
   
 ID of the feature whose translation is desired  
   
 =item RETURN  
   
 Returns the translation of the specified feature.  
   
 =back  
   
 =cut  
 #: Return Type $;  
 sub FeatureTranslation {  
     # Get the parameters.  
     my ($self, $featureID) = @_;  
     # Get the specified feature's translation.  
     my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);  
     return $retVal;  
 }  
   
 =head3 Taxonomy  
   
 C<< my @taxonomyList = $sprout->Taxonomy($genome); >>  
2350    
2351  Return the taxonomy of the specified genome. This will be in the form of a list  Return the taxonomy of the specified genome. This will be in the form of a list
2352  containing the various classifications in order from domain (eg. C<Bacteria>, C<Archaea>,  containing the various classifications in order from domain (eg. C<Bacteria>, C<Archaea>,
2353  or C<Eukaryote>) to sub-species. For example,  or C<Eukaryote>) to sub-species. For example,
2354    
2355  C<< (Bacteria, Proteobacteria, Gammaproteobacteria, Enterobacteriales, Enterobacteriaceae, Escherichia, Escherichia coli, Escherichia coli K12) >>      (Bacteria, Proteobacteria, Gammaproteobacteria, Enterobacteriales, Enterobacteriaceae, Escherichia, Escherichia coli, Escherichia coli K12)
2356    
2357  =over 4  =over 4
2358    
# Line 2200  Line 2387 
2387    
2388  =head3 CrudeDistance  =head3 CrudeDistance
2389    
2390  C<< my $distance = $sprout->CrudeDistance($genome1, $genome2); >>      my $distance = $sprout->CrudeDistance($genome1, $genome2);
2391    
2392  Returns a crude estimate of the distance between two genomes. The distance is construed so  Returns a crude estimate of the distance between two genomes. The distance is construed so
2393  that it will be 0 for genomes with identical taxonomies and 1 for genomes from different domains.  that it will be 0 for genomes with identical taxonomies and 1 for genomes from different domains.
# Line 2252  Line 2439 
2439    
2440  =head3 RoleName  =head3 RoleName
2441    
2442  C<< my $roleName = $sprout->RoleName($roleID); >>      my $roleName = $sprout->RoleName($roleID);
2443    
2444  Return the descriptive name of the role with the specified ID. In general, a role  Return the descriptive name of the role with the specified ID. In general, a role
2445  will only have a descriptive name if it is coded as an EC number.  will only have a descriptive name if it is coded as an EC number.
# Line 2286  Line 2473 
2473    
2474  =head3 RoleDiagrams  =head3 RoleDiagrams
2475    
2476  C<< my @diagrams = $sprout->RoleDiagrams($roleID); >>      my @diagrams = $sprout->RoleDiagrams($roleID);
2477    
2478  Return a list of the diagrams containing a specified functional role.  Return a list of the diagrams containing a specified functional role.
2479    
# Line 2316  Line 2503 
2503    
2504  =head3 GetProperties  =head3 GetProperties
2505    
2506  C<< my @list = $sprout->GetProperties($fid, $key, $value, $url); >>      my @list = $sprout->GetProperties($fid, $key, $value, $url);
2507    
2508  Return a list of the properties with the specified characteristics.  Return a list of the properties with the specified characteristics.
2509    
2510  Properties are arbitrary key-value pairs associated with a feature. (At some point they  Properties are the Sprout analog of the FIG attributes. The call is
2511  will also be associated with genomes.) A property value is represented by a 4-tuple of  passed directly to the CustomAttributes or RemoteCustomAttributes object
2512  the form B<($fid, $key, $value, $url)>. These exactly correspond to the parameter  contained in this object.
2513    
2514  =over 4  This method returns a series of tuples that match the specified criteria. Each tuple
2515    will contain an object ID, a key, and one or more values. The parameters to this
2516    method therefore correspond structurally to the values expected in each tuple. In
2517    addition, you can ask for a generic search by suffixing a percent sign (C<%>) to any
2518    of the parameters. So, for example,
2519    
2520  =item fid      my @attributeList = $sprout->GetProperties('fig|100226.1.peg.1004', 'structure%', 1, 2);
2521    
2522  ID of the feature possessing the property.  would return something like
2523    
2524  =item key      ['fig}100226.1.peg.1004', 'structure', 1, 2]
2525        ['fig}100226.1.peg.1004', 'structure1', 1, 2]
2526        ['fig}100226.1.peg.1004', 'structure2', 1, 2]
2527        ['fig}100226.1.peg.1004', 'structureA', 1, 2]
2528    
2529  Name or key of the property.  Use of C<undef> in any position acts as a wild card (all values). You can also specify
2530    a list reference in the ID column. Thus,
2531    
2532  =item value      my @attributeList = $sprout->GetProperties(['100226.1', 'fig|100226.1.%'], 'PUBMED');
2533    
2534  Value of the property.  would get the PUBMED attribute data for Streptomyces coelicolor A3(2) and all its
2535    features.
2536    
2537  =item url  In addition to values in multiple sections, a single attribute key can have multiple
2538    values, so even
2539    
2540  URL of the document that indicated the property should have this particular value, or an      my @attributeList = $sprout->GetProperties($peg, 'virulent');
 empty string if no such document exists.  
2541    
2542  =back  which has no wildcard in the key or the object ID, may return multiple tuples.
2543    
2544    =over 4
2545    
2546  The parameters act as a filter for the desired data. Any non-null parameter will  =item objectID
 automatically match all the tuples returned. So, specifying just the I<$fid> will  
 return all the properties of the specified feature; similarly, specifying the I<$key>  
 and I<$value> parameters will return all the features having the specified property  
 value.  
2547    
2548  A single property key can have many values, representing different ideas about the  ID of object whose attributes are desired. If the attributes are desired for multiple
2549  feature in question. For example, one paper may declare that a feature C<fig|83333.1.peg.10> is  objects, this parameter can be specified as a list reference. If the attributes are
2550  virulent, and another may declare that it is not virulent. A query about the virulence of  desired for all objects, specify C<undef> or an empty string. Finally, you can specify
2551  C<fig|83333.1.peg.10> would be coded as  attributes for a range of object IDs by putting a percent sign (C<%>) at the end.
2552    
2553      my @list = $sprout->GetProperties('fig|83333.1.peg.10', 'virulence', '', '');  =item key
2554    
2555    Attribute key name. A value of C<undef> or an empty string will match all
2556    attribute keys. If the values are desired for multiple keys, this parameter can be
2557    specified as a list reference. Finally, you can specify attributes for a range of
2558    keys by putting a percent sign (C<%>) at the end.
2559    
2560    =item values
2561    
2562    List of the desired attribute values, section by section. If C<undef>
2563    or an empty string is specified, all values in that section will match. A
2564    generic match can be requested by placing a percent sign (C<%>) at the end.
2565    In that case, all values that match up to and not including the percent sign
2566    will match. You may also specify a regular expression enclosed
2567    in slashes. All values that match the regular expression will be returned. For
2568    performance reasons, only values have this extra capability.
2569    
2570  Here the I<$value> and I<$url> fields are left blank, indicating that those fields are  =item RETURN
 not to be filtered. The tuples returned would be  
2571    
2572      ('fig|83333.1.peg.10', 'virulence', 'yes', 'http://www.somewhere.edu/first.paper.pdf')  Returns a list of tuples. The first element in the tuple is an object ID, the
2573      ('fig|83333.1.peg.10', 'virulence', 'no', 'http://www.somewhere.edu/second.paper.pdf')  second is an attribute key, and the remaining elements are the sections of
2574    the attribute value. All of the tuples will match the criteria set forth in
2575    the parameter list.
2576    
2577    =back
2578    
2579  =cut  =cut
2580  #: Return Type @@;  
2581  sub GetProperties {  sub GetProperties {
2582      # Get the parameters.      # Get the parameters.
2583      my ($self, @parms) = @_;      my ($self, @parms) = @_;
2584      # Declare the return variable.      # Declare the return variable.
2585      my @retVal = ();      my @retVal = $self->{_ca}->GetAttributes(@parms);
     # Now we need to create a WHERE clause that will get us the data we want. First,  
     # we create a list of the columns containing the data for each parameter.  
     my @colNames = ('HasProperty(from-link)', 'Property(property-name)',  
                     'Property(property-value)', 'HasProperty(evidence)');  
     # Now we build the WHERE clause and the list of parameter values.  
     my @where = ();  
     my @values = ();  
     for (my $i = 0; $i <= $#colNames; $i++) {  
         my $parm = $parms[$i];  
         if (defined $parm && ($parm ne '')) {  
             push @where, "$colNames[$i] = ?";  
             push @values, $parm;  
         }  
     }  
     # Format the WHERE clause.  
     my $filter = (@values > 0 ? (join " AND ", @where) : undef);  
     # Ask for all the propertie values with the desired characteristics.  
     my $query = $self->Get(['HasProperty', 'Property'], $filter, \@values);  
     while (my $valueObject = $query->Fetch()) {  
         my @tuple = $valueObject->Values(\@colNames);  
         push @retVal, \@tuple;  
     }  
2586      # Return the result.      # Return the result.
2587      return @retVal;      return @retVal;
2588  }  }
2589    
2590  =head3 FeatureProperties  =head3 FeatureProperties
2591    
2592  C<< my @properties = $sprout->FeatureProperties($featureID); >>      my @properties = $sprout->FeatureProperties($featureID);
2593    
2594  Return a list of the properties for the specified feature. Properties are key-value pairs  Return a list of the properties for the specified feature. Properties are key-value pairs
2595  that specify special characteristics of the feature. For example, a property could indicate  that specify special characteristics of the feature. For example, a property could indicate
2596  that a feature is essential to the survival of the organism or that it has benign influence  that a feature is essential to the survival of the organism or that it has benign influence
2597  on the activities of a pathogen. Each property is returned as a triple of the form  on the activities of a pathogen. Each property is returned as a triple of the form
2598  C<($key,$value,$url)>, where C<$key> is the property name, C<$value> is its value (commonly  C<($key,@values)>, where C<$key> is the property name and  C<@values> are its values.
 a 1 or a 0, but possibly a string or a floating-point value), and C<$url> is a string describing  
 the web address or citation in which the property's value for the feature was identified.  
2599    
2600  =over 4  =over 4
2601    
# Line 2417  Line 2605 
2605    
2606  =item RETURN  =item RETURN
2607    
2608  Returns a list of triples, each triple containing the property name, its value, and a URL or  Returns a list of tuples, each tuple containing the property name and its values.
 citation.  
2609    
2610  =back  =back
2611    
# Line 2428  Line 2615 
2615      # Get the parameters.      # Get the parameters.
2616      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2617      # Get the properties.      # Get the properties.
2618      my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],      my @attributes = $self->{_ca}->GetAttributes($featureID);
2619                              ['Property(property-name)', 'Property(property-value)',      # Strip the feature ID off each tuple.
2620                               'HasProperty(evidence)']);      my @retVal = ();
2621        for my $attributeRow (@attributes) {
2622            shift @{$attributeRow};
2623            push @retVal, $attributeRow;
2624        }
2625      # Return the resulting list.      # Return the resulting list.
2626      return @retVal;      return @retVal;
2627  }  }
2628    
2629  =head3 DiagramName  =head3 DiagramName
2630    
2631  C<< my $diagramName = $sprout->DiagramName($diagramID); >>      my $diagramName = $sprout->DiagramName($diagramID);
2632    
2633  Return the descriptive name of a diagram.  Return the descriptive name of a diagram.
2634    
# Line 2463  Line 2654 
2654      return $retVal;      return $retVal;
2655  }  }
2656    
2657    =head3 PropertyID
2658    
2659        my $id = $sprout->PropertyID($propName, $propValue);
2660    
2661    Return the ID of the specified property name and value pair, if the
2662    pair exists. Only a small subset of the FIG attributes are stored as
2663    Sprout properties, mostly for use in search optimization.
2664    
2665    =over 4
2666    
2667    =item propName
2668    
2669    Name of the desired property.
2670    
2671    =item propValue
2672    
2673    Value expected for the desired property.
2674    
2675    =item RETURN
2676    
2677    Returns the ID of the name/value pair, or C<undef> if the pair does not exist.
2678    
2679    =back
2680    
2681    =cut
2682    
2683    sub PropertyID {
2684        # Get the parameters.
2685        my ($self, $propName, $propValue) = @_;
2686        # Try to find the ID.
2687        my ($retVal) = $self->GetFlat(['Property'],
2688                                      "Property(property-name) = ? AND Property(property-value) = ?",
2689                                      [$propName, $propValue], 'Property(id)');
2690        # Return the result.
2691        return $retVal;
2692    }
2693    
2694  =head3 MergedAnnotations  =head3 MergedAnnotations
2695    
2696  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>      my @annotationList = $sprout->MergedAnnotations(\@list);
2697    
2698  Returns a merged list of the annotations for the features in a list. Each annotation is  Returns a merged list of the annotations for the features in a list. Each annotation is
2699  represented by a 4-tuple of the form C<($fid, $timestamp, $userID, $annotation)>, where  represented by a 4-tuple of the form C<($fid, $timestamp, $userID, $annotation)>, where
# Line 2514  Line 2742 
2742    
2743  =head3 RoleNeighbors  =head3 RoleNeighbors
2744    
2745  C<< my @roleList = $sprout->RoleNeighbors($roleID); >>      my @roleList = $sprout->RoleNeighbors($roleID);
2746    
2747  Returns a list of the roles that occur in the same diagram as the specified role. Because  Returns a list of the roles that occur in the same diagram as the specified role. Because
2748  diagrams and roles are in a many-to-many relationship with each other, the list is  diagrams and roles are in a many-to-many relationship with each other, the list is
# Line 2557  Line 2785 
2785    
2786  =head3 FeatureLinks  =head3 FeatureLinks
2787    
2788  C<< my @links = $sprout->FeatureLinks($featureID); >>      my @links = $sprout->FeatureLinks($featureID);
2789    
2790  Return a list of the web hyperlinks associated with a feature. The web hyperlinks are  Return a list of the web hyperlinks associated with a feature. The web hyperlinks are
2791  to external websites describing either the feature itself or the organism containing it  to external websites describing either the feature itself or the organism containing it
# Line 2588  Line 2816 
2816    
2817  =head3 SubsystemsOf  =head3 SubsystemsOf
2818    
2819  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>      my %subsystems = $sprout->SubsystemsOf($featureID);
2820    
2821  Return a hash describing all the subsystems in which a feature participates. Each subsystem is mapped  Return a hash describing all the subsystems in which a feature participates. Each subsystem is mapped
2822  to the roles the feature performs.  to the roles the feature performs.
# Line 2636  Line 2864 
2864    
2865  =head3 SubsystemList  =head3 SubsystemList
2866    
2867  C<< my @subsystems = $sprout->SubsystemList($featureID); >>      my @subsystems = $sprout->SubsystemList($featureID);
2868    
2869  Return a list containing the names of the subsystems in which the specified  Return a list containing the names of the subsystems in which the specified
2870  feature participates. Unlike L</SubsystemsOf>, this method only returns the  feature participates. Unlike L</SubsystemsOf>, this method only returns the
# Line 2660  Line 2888 
2888      # Get the parameters.      # Get the parameters.
2889      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2890      # Get the list of names.      # Get the list of names.
2891      my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",      my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",
2892                                  [$featureID], 'HasSSCell(from-link)');                                  [$featureID], 'HasRoleInSubsystem(to-link)');
2893      # Return the result.      # Return the result, sorted.
2894      return @retVal;      return sort @retVal;
2895  }  }
2896    
2897    =head3 GenomeSubsystemData
2898    
2899        my %featureData = $sprout->GenomeSubsystemData($genomeID);
2900    
2901    Return a hash mapping genome features to their subsystem roles.
2902    
2903    =over 4
2904    
2905    =item genomeID
2906    
2907    ID of the genome whose subsystem feature map is desired.
2908    
2909    =item RETURN
2910    
2911    Returns a hash mapping each feature of the genome to a list of 2-tuples. Eacb
2912    2-tuple contains a subsystem name followed by a role ID.
2913    
2914    =back
2915    
2916    =cut
2917    
2918    sub GenomeSubsystemData {
2919        # Get the parameters.
2920        my ($self, $genomeID) = @_;
2921        # Declare the return variable.
2922        my %retVal = ();
2923        # Get a list of the genome features that participate in subsystems. For each
2924        # feature we get its spreadsheet cells and the corresponding roles.
2925        my @roleData = $self->GetAll(['HasFeature', 'ContainsFeature', 'IsRoleOf'],
2926                                 "HasFeature(from-link) = ?", [$genomeID],
2927                                 ['HasFeature(to-link)', 'IsRoleOf(to-link)', 'IsRoleOf(from-link)']);
2928        # Now we get a list of the spreadsheet cells and their associated subsystems. Subsystems
2929        # with an unknown variant code (-1) are skipped. Note the genome ID is at both ends of the
2930        # list. We use it at the beginning to get all the spreadsheet cells for the genome and
2931        # again at the end to filter out participation in subsystems with a negative variant code.
2932        my @cellData = $self->GetAll(['IsGenomeOf', 'HasSSCell', 'ParticipatesIn'],
2933                                     "IsGenomeOf(from-link) = ? AND ParticipatesIn(variant-code) >= 0 AND ParticipatesIn(from-link) = ?",
2934                                     [$genomeID, $genomeID], ['HasSSCell(to-link)', 'HasSSCell(from-link)']);
2935        # Now "@roleData" lists the spreadsheet cell and role for each of the genome's features.
2936        # "@cellData" lists the subsystem name for each of the genome's spreadsheet cells. We
2937        # link these two lists together to create the result. First, we want a hash mapping
2938        # spreadsheet cells to subsystem names.
2939        my %subHash = map { $_->[0] => $_->[1] } @cellData;
2940        # We loop through @cellData to build the hash.
2941        for my $roleEntry (@roleData) {
2942            # Get the data for this feature and cell.
2943            my ($fid, $cellID, $role) = @{$roleEntry};
2944            # Check for a subsystem name.
2945            my $subsys = $subHash{$cellID};
2946            if ($subsys) {
2947                # Insure this feature has an entry in the return hash.
2948                if (! exists $retVal{$fid}) { $retVal{$fid} = []; }
2949                # Merge in this new data.
2950                push @{$retVal{$fid}}, [$subsys, $role];
2951            }
2952        }
2953        # Return the result.
2954        return %retVal;
2955    }
2956    
2957  =head3 RelatedFeatures  =head3 RelatedFeatures
2958    
2959  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>      my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID);
2960    
2961  Return a list of the features which are bi-directional best hits of the specified feature and  Return a list of the features which are bi-directional best hits of the specified feature and
2962  have been assigned the specified function by the specified user. If no such features exists,  have been assigned the specified function by the specified user. If no such features exists,
# Line 2703  Line 2989 
2989      # Get the parameters.      # Get the parameters.
2990      my ($self, $featureID, $function, $userID) = @_;      my ($self, $featureID, $function, $userID) = @_;
2991      # 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.
2992      my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],      my @bbhFeatures = map { $_->[0] } FIGRules::BBHData($featureID);
                                      "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],  
                                      'IsBidirectionalBestHitOf(to-link)');  
2993      # 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
2994      # functional assignment.      # functional assignment.
2995      my @retVal = ();      my @retVal = ();
# Line 2723  Line 3007 
3007    
3008  =head3 TaxonomySort  =head3 TaxonomySort
3009    
3010  C<< my @sortedFeatureIDs = $sprout->TaxonomySort(\@featureIDs); >>      my @sortedFeatureIDs = $sprout->TaxonomySort(\@featureIDs);
3011    
3012  Return a list formed by sorting the specified features by the taxonomy of the containing  Return a list formed by sorting the specified features by the taxonomy of the containing
3013  genome. This will cause genomes from similar organisms to float close to each other.  genome. This will cause genomes from similar organisms to float close to each other.
# Line 2758  Line 3042 
3042          my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",          my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",
3043                                          [$fid], 'Genome(taxonomy)');                                          [$fid], 'Genome(taxonomy)');
3044          # Add this feature to the hash buffer.          # Add this feature to the hash buffer.
3045          Tracer::AddToListMap(\%hashBuffer, $taxonomy, $fid);          push @{$hashBuffer{$taxonomy}}, $fid;
3046      }      }
3047      # Sort the keys and get the elements.      # Sort the keys and get the elements.
3048      my @retVal = ();      my @retVal = ();
# Line 2771  Line 3055 
3055    
3056  =head3 Protein  =head3 Protein
3057    
3058  C<< my $protein = Sprout::Protein($sequence, $table); >>      my $protein = Sprout::Protein($sequence, $table);
3059    
3060  Translate a DNA sequence into a protein sequence.  Translate a DNA sequence into a protein sequence.
3061    
# Line 2841  Line 3125 
3125      # Loop through the input triples.      # Loop through the input triples.
3126      my $n = length $sequence;      my $n = length $sequence;
3127      for (my $i = 0; $i < $n; $i += 3) {      for (my $i = 0; $i < $n; $i += 3) {
3128          # Get the current triple from the sequence.          # Get the current triple from the sequence. Note we convert to
3129          my $triple = substr($sequence, $i, 3);          # upper case to insure a match.
3130            my $triple = uc substr($sequence, $i, 3);
3131          # Translate it using the table.          # Translate it using the table.
3132          my $protein = "X";          my $protein = "X";
3133          if (exists $table->{$triple}) { $protein = $table->{$triple}; }          if (exists $table->{$triple}) { $protein = $table->{$triple}; }
# Line 2856  Line 3141 
3141    
3142  =head3 LoadInfo  =head3 LoadInfo
3143    
3144  C<< my ($dirName, @relNames) = $sprout->LoadInfo(); >>      my ($dirName, @relNames) = $sprout->LoadInfo();
3145    
3146  Return the name of the directory from which data is to be loaded and a list of the relation  Return the name of the directory from which data is to be loaded and a list of the relation
3147  names. This information is useful when trying to analyze what needs to be put where in order  names. This information is useful when trying to analyze what needs to be put where in order
# Line 2875  Line 3160 
3160      return @retVal;      return @retVal;
3161  }  }
3162    
3163    =head3 BBHMatrix
3164    
3165        my %bbhMap = $sprout->BBHMatrix($genomeID, $cutoff, @targets);
3166    
3167    Find all the bidirectional best hits for the features of a genome in a
3168    specified list of target genomes. The return value will be a hash mapping
3169    features in the original genome to their bidirectional best hits in the
3170    target genomes.
3171    
3172    =over 4
3173    
3174    =item genomeID
3175    
3176    ID of the genome whose features are to be examined for bidirectional best hits.
3177    
3178    =item cutoff
3179    
3180    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3181    
3182    =item targets
3183    
3184    List of target genomes. Only pairs originating in the original
3185    genome and landing in one of the target genomes will be returned.
3186    
3187    =item RETURN
3188    
3189    Returns a hash mapping each feature in the original genome to a hash mapping its
3190    BBH pegs in the target genomes to their scores.
3191    
3192    =back
3193    
3194    =cut
3195    
3196    sub BBHMatrix {
3197        # Get the parameters.
3198        my ($self, $genomeID, $cutoff, @targets) = @_;
3199        # Declare the return variable.
3200        my %retVal = ();
3201        # Ask for the BBHs.
3202        my @bbhList = FIGRules::BatchBBHs("fig|$genomeID.%", $cutoff, @targets);
3203        # We now have a set of 4-tuples that we need to convert into a hash of hashes.
3204        for my $bbhData (@bbhList) {
3205            my ($peg1, $peg2, $score) = @{$bbhData};
3206            if (! exists $retVal{$peg1}) {
3207                $retVal{$peg1} = { $peg2 => $score };
3208            } else {
3209                $retVal{$peg1}->{$peg2} = $score;
3210            }
3211        }
3212        # Return the result.
3213        return %retVal;
3214    }
3215    
3216    
3217    =head3 SimMatrix
3218    
3219        my %simMap = $sprout->SimMatrix($genomeID, $cutoff, @targets);
3220    
3221    Find all the similarities for the features of a genome in a
3222    specified list of target genomes. The return value will be a hash mapping
3223    features in the original genome to their similarites in the
3224    target genomes.
3225    
3226    =over 4
3227    
3228    =item genomeID
3229    
3230    ID of the genome whose features are to be examined for similarities.
3231    
3232    =item cutoff
3233    
3234    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3235    
3236    =item targets
3237    
3238    List of target genomes. Only pairs originating in the original
3239    genome and landing in one of the target genomes will be returned.
3240    
3241    =item RETURN
3242    
3243    Returns a hash mapping each feature in the original genome to a hash mapping its
3244    similar pegs in the target genomes to their scores.
3245    
3246    =back
3247    
3248    =cut
3249    
3250    sub SimMatrix {
3251        # Get the parameters.
3252        my ($self, $genomeID, $cutoff, @targets) = @_;
3253        # Declare the return variable.
3254        my %retVal = ();
3255        # Get the list of features in the source organism.
3256        my @fids = $self->FeaturesOf($genomeID);
3257        # Ask for the sims. We only want similarities to fig features.
3258        my $simList = FIGRules::GetNetworkSims($self, \@fids, {}, 1000, $cutoff, "fig");
3259        if (! defined $simList) {
3260            Confess("Unable to retrieve similarities from server.");
3261        } else {
3262            Trace("Processing sims.") if T(3);
3263            # We now have a set of sims that we need to convert into a hash of hashes. First, we
3264            # Create a hash for the target genomes.
3265            my %targetHash = map { $_ => 1 } @targets;
3266            for my $simData (@{$simList}) {
3267                # Get the PEGs and the score.
3268                my ($peg1, $peg2, $score) = ($simData->id1, $simData->id2, $simData->psc);
3269                # Insure the second ID is in the target list.
3270                my ($genome2) = FIGRules::ParseFeatureID($peg2);
3271                if (exists $targetHash{$genome2}) {
3272                    # Here it is. Now we need to add it to the return hash. How we do that depends
3273                    # on whether or not $peg1 is new to us.
3274                    if (! exists $retVal{$peg1}) {
3275                        $retVal{$peg1} = { $peg2 => $score };
3276                    } else {
3277                        $retVal{$peg1}->{$peg2} = $score;
3278                    }
3279                }
3280            }
3281        }
3282        # Return the result.
3283        return %retVal;
3284    }
3285    
3286    
3287  =head3 LowBBHs  =head3 LowBBHs
3288    
3289  C<< my %bbhMap = $sprout->LowBBHs($featureID, $cutoff); >>      my %bbhMap = $sprout->LowBBHs($featureID, $cutoff);
3290    
3291  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
3292  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 2906  Line 3315 
3315      my ($self, $featureID, $cutoff) = @_;      my ($self, $featureID, $cutoff) = @_;
3316      # Create the return hash.      # Create the return hash.
3317      my %retVal = ();      my %retVal = ();
3318      # Create a query to get the desired BBHs.      # Query for the desired BBHs.
3319      my @bbhList = $self->GetAll(['IsBidirectionalBestHitOf'],      my @bbhList = FIGRules::BBHData($featureID, $cutoff);
                                 'IsBidirectionalBestHitOf(sc) <= ? AND IsBidirectionalBestHitOf(from-link) = ?',  
                                 [$cutoff, $featureID],  
                                 ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(sc)']);  
3320      # Form the results into the return hash.      # Form the results into the return hash.
3321      for my $pair (@bbhList) {      for my $pair (@bbhList) {
3322          $retVal{$pair->[0]} = $pair->[1];          my $fid = $pair->[0];
3323            if ($self->Exists('Feature', $fid)) {
3324                $retVal{$fid} = $pair->[1];
3325            }
3326      }      }
3327      # Return the result.      # Return the result.
3328      return %retVal;      return %retVal;
3329  }  }
3330    
3331    =head3 Sims
3332    
3333        my $simList = $sprout->Sims($fid, $maxN, $maxP, $select, $max_expand, $filters);
3334    
3335    Get a list of similarities for a specified feature. Similarity information is not kept in the
3336    Sprout database; rather, they are retrieved from a network server. The similarities are
3337    returned as B<Sim> objects. A Sim object is actually a list reference that has been blessed
3338    so that its elements can be accessed by name.
3339    
3340    Similarities can be either raw or expanded. The raw similarities are basic
3341    hits between features with similar DNA. Expanding a raw similarity drags in any
3342    features considered substantially identical. So, for example, if features B<A1>,
3343    B<A2>, and B<A3> are all substantially identical to B<A>, then a raw similarity
3344    B<[C,A]> would be expanded to B<[C,A] [C,A1] [C,A2] [C,A3]>.
3345    
3346    =over 4
3347    
3348    =item fid
3349    
3350    ID of the feature whose similarities are desired, or reference to a list of IDs
3351    of features whose similarities are desired.
3352    
3353    =item maxN
3354    
3355    Maximum number of similarities to return.
3356    
3357    =item maxP
3358    
3359    Minumum allowable similarity score.
3360    
3361    =item select
3362    
3363    Selection criterion: C<raw> means only raw similarities are returned; C<fig>
3364    means only similarities to FIG features are returned; C<all> means all expanded
3365    similarities are returned; and C<figx> means similarities are expanded until the
3366    number of FIG features equals the maximum.
3367    
3368    =item max_expand
3369    
3370    The maximum number of features to expand.
3371    
3372    =item filters
3373    
3374    Reference to a hash containing filter information, or a subroutine that can be
3375    used to filter the sims.
3376    
3377    =item RETURN
3378    
3379    Returns a reference to a list of similarity objects, or C<undef> if an error
3380    occurred.
3381    
3382    =back
3383    
3384    =cut
3385    
3386    sub Sims {
3387        # Get the parameters.
3388        my ($self, $fid, $maxN, $maxP, $select, $max_expand, $filters) = @_;
3389        # Create the shim object to test for deleted FIDs.
3390        my $shim = FidCheck->new($self);
3391        # Ask the network for sims.
3392        my $retVal = FIGRules::GetNetworkSims($shim, $fid, {}, $maxN, $maxP, $select, $max_expand, $filters);
3393        # Return the result.
3394        return $retVal;
3395    }
3396    
3397    =head3 IsAllGenomes
3398    
3399        my $flag = $sprout->IsAllGenomes(\@list, \@checkList);
3400    
3401    Return TRUE if all genomes in the second list are represented in the first list at
3402    least one. Otherwise, return FALSE. If the second list is omitted, the first list is
3403    compared to a list of all the genomes.
3404    
3405    =over 4
3406    
3407    =item list
3408    
3409    Reference to the list to be compared to the second list.
3410    
3411    =item checkList (optional)
3412    
3413    Reference to the comparison target list. Every genome ID in this list must occur at
3414    least once in the first list. If this parameter is omitted, a list of all the genomes
3415    is used.
3416    
3417    =item RETURN
3418    
3419    Returns TRUE if every item in the second list appears at least once in the
3420    first list, else FALSE.
3421    
3422    =back
3423    
3424    =cut
3425    
3426    sub IsAllGenomes {
3427        # Get the parameters.
3428        my ($self, $list, $checkList) = @_;
3429        # Supply the checklist if it was omitted.
3430        $checkList = [$self->Genomes()] if ! defined($checkList);
3431        # Create a hash of the original list.
3432        my %testList = map { $_ => 1 } @{$list};
3433        # Declare the return variable. We assume that the representation
3434        # is complete and stop at the first failure.
3435        my $retVal = 1;
3436        my $n = scalar @{$checkList};
3437        for (my $i = 0; $retVal && $i < $n; $i++) {
3438            if (! $testList{$checkList->[$i]}) {
3439                $retVal = 0;
3440            }
3441        }
3442        # Return the result.
3443        return $retVal;
3444    }
3445    
3446  =head3 GetGroups  =head3 GetGroups
3447    
3448  C<< my %groups = $sprout->GetGroups(\@groupList); >>      my %groups = $sprout->GetGroups(\@groupList);
3449    
3450  Return a hash mapping each group to the IDs of the genomes in the group.  Return a hash mapping each group to the IDs of the genomes in the group.
3451  A list of groups may be specified, in which case only those groups will be  A list of groups may be specified, in which case only those groups will be
# Line 2940  Line 3464 
3464          # Here we have a group list. Loop through them individually,          # Here we have a group list. Loop through them individually,
3465          # getting a list of the relevant genomes.          # getting a list of the relevant genomes.
3466          for my $group (@{$groupList}) {          for my $group (@{$groupList}) {
3467              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(group-name) = ?",              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(primary-group) = ?",
3468                  [$group], "Genome(id)");                  [$group], "Genome(id)");
3469              $retVal{$group} = \@genomeIDs;              $retVal{$group} = \@genomeIDs;
3470          }          }
# Line 2948  Line 3472 
3472          # 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
3473          # of the genome records, putting each one found into the appropriate          # of the genome records, putting each one found into the appropriate
3474          # 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
3475          # in groups are included in the return set.          # in real NMPDR groups are included in the return set.
3476          my @genomes = $self->GetAll(['Genome'], "Genome(group-name) > ' '", [],          my @genomes = $self->GetAll(['Genome'], "Genome(primary-group) <> ?",
3477                                      ['Genome(id)', 'Genome(group-name)']);                                      [$FIG_Config::otherGroup], ['Genome(id)', 'Genome(primary-group)']);
3478          # Loop through the genomes found.          # Loop through the genomes found.
3479          for my $genome (@genomes) {          for my $genome (@genomes) {
3480              # Pop this genome's ID off the current list.              # Get the genome ID and group, and add this genome to the group's list.
3481              my @groups = @{$genome};              my ($genomeID, $group) = @{$genome};
3482              my $genomeID = shift @groups;              push @{$retVal{$group}}, $genomeID;
             # Loop through the groups, adding the genome ID to each group's  
             # list.  
             for my $group (@groups) {  
                 Tracer::AddToListMap(\%retVal, $group, $genomeID);  
             }  
3483          }          }
3484      }      }
3485      # Return the hash we just built.      # Return the hash we just built.
# Line 2969  Line 3488 
3488    
3489  =head3 MyGenomes  =head3 MyGenomes
3490    
3491  C<< my @genomes = Sprout::MyGenomes($dataDir); >>      my @genomes = Sprout::MyGenomes($dataDir);
3492    
3493  Return a list of the genomes to be included in the Sprout.  Return a list of the genomes to be included in the Sprout.
3494    
# Line 3001  Line 3520 
3520    
3521  =head3 LoadFileName  =head3 LoadFileName
3522    
3523  C<< my $fileName = Sprout::LoadFileName($dataDir, $tableName); >>      my $fileName = Sprout::LoadFileName($dataDir, $tableName);
3524    
3525  Return the name of the load file for the specified table in the specified data  Return the name of the load file for the specified table in the specified data
3526  directory.  directory.
# Line 3042  Line 3561 
3561    
3562  =head3 DeleteGenome  =head3 DeleteGenome
3563    
3564  C<< my $stats = $sprout->DeleteGenome($genomeID, $testFlag); >>      my $stats = $sprout->DeleteGenome($genomeID, $testFlag);
3565    
3566  Delete a genome from the database.  Delete a genome from the database.
3567    
# Line 3068  Line 3587 
3587      # Get the parameters.      # Get the parameters.
3588      my ($self, $genomeID, $testFlag) = @_;      my ($self, $genomeID, $testFlag) = @_;
3589      # Perform the delete for the genome's features.      # Perform the delete for the genome's features.
3590      my $retVal = $self->Delete('Feature', "fig|$genomeID.%", $testFlag);      my $retVal = $self->Delete('Feature', "fig|$genomeID.%", testMode => $testFlag);
3591      # Perform the delete for the primary genome data.      # Perform the delete for the primary genome data.
3592      my $stats = $self->Delete('Genome', $genomeID, $testFlag);      my $stats = $self->Delete('Genome', $genomeID, testMode => $testFlag);
3593      $retVal->Accumulate($stats);      $retVal->Accumulate($stats);
3594      # Return the result.      # Return the result.
3595      return $retVal;      return $retVal;
3596  }  }
3597    
3598    =head3 Fix
3599    
3600        my %fixedHash = $sprout->Fix(%groupHash);
3601    
3602    Prepare a genome group hash (like that returned by L</GetGroups>) for processing.
3603    The groups will be combined into the appropriate super-groups.
3604    
3605    =over 4
3606    
3607    =item groupHash
3608    
3609    Hash to be fixed up.
3610    
3611    =item RETURN
3612    
3613    Returns a fixed-up version of the hash.
3614    
3615    =back
3616    
3617    =cut
3618    
3619    sub Fix {
3620        # Get the parameters.
3621        my ($self, %groupHash) = @_;
3622        # Create the result hash.
3623        my %retVal = ();
3624        # Get the super-group table.
3625        my %superTable = $self->CheckGroupFile();
3626        # Copy over the genomes.
3627        for my $groupID (keys %groupHash) {
3628            # Get the super-group name.
3629            my $realGroupID;
3630            if ($groupID =~ /([A-Z]\w+)/) {
3631                if (! defined($superTable{$1})) {
3632                    Confess("Super-group name not found for group $groupID.");
3633                } else {
3634                    $realGroupID = $1;
3635                }
3636            } else {
3637                Confess("Invalid group name $groupID.");
3638            }
3639            # Append this group's genomes into the result hash.
3640            push @{$retVal{$realGroupID}}, @{$groupHash{$groupID}};
3641        }
3642        # Return the result hash.
3643        return %retVal;
3644    }
3645    
3646    =head3 GroupPageName
3647    
3648        my $name = $sprout->GroupPageName($group);
3649    
3650    Return the name of the page for the specified NMPDR group.
3651    
3652    =over 4
3653    
3654    =item group
3655    
3656    Name of the relevant group.
3657    
3658    =item RETURN
3659    
3660    Returns the relative page name (e.g. C<../content/campy.php>). If the group file is not in
3661    memory it will be read in.
3662    
3663    =back
3664    
3665    =cut
3666    
3667    sub GroupPageName {
3668        # Get the parameters.
3669        my ($self, $group) = @_;
3670        # Declare the return variable.
3671        my $retVal;
3672        # Check for the group file data.
3673        my %superTable = $self->CheckGroupFile();
3674        # Compute the real group name.
3675        if ($group =~ /([A-Z]\w+)/) {
3676            my $realGroup = $1;
3677            if (! defined($superTable{$1})) {
3678                Confess("No super-group found for \"$group\".");
3679            } else {
3680                $retVal = "../content/$superTable{$1}->{page}";
3681            }
3682        } else {
3683            Confess("\"group\" is not a valid group name.");
3684        }
3685        # Return the result.
3686        return $retVal;
3687    }
3688    
3689    
3690    =head3 AddProperty
3691    
3692        $sprout->AddProperty($featureID, $key, @values);
3693    
3694    Add a new attribute value (Property) to a feature.
3695    
3696    =over 4
3697    
3698    =item peg
3699    
3700    ID of the feature to which the attribute is to be added.
3701    
3702    =item key
3703    
3704    Name of the attribute (key).
3705    
3706    =item values
3707    
3708    Values of the attribute.
3709    
3710    =back
3711    
3712    =cut
3713    #: Return Type ;
3714    sub AddProperty {
3715        # Get the parameters.
3716        my ($self, $featureID, $key, @values) = @_;
3717        # Add the property using the attached attributes object.
3718        $self->{_ca}->AddAttribute($featureID, $key, @values);
3719    }
3720    
3721    =head3 CheckGroupFile
3722    
3723        my %groupData = $sprout->CheckGroupFile();
3724    
3725    Get the group file hash. The group file hash describes the relationship
3726    between a group and the super-group to which it belongs for purposes of
3727    display. The super-group name is computed from the first capitalized word
3728    in the actual group name. For each super-group, the group file contains
3729    the page name and a list of the species expected to be in the group.
3730    Each species is specified by a genus and a species name. A species name
3731    of C<0> implies an entire genus.
3732    
3733    This method returns a hash from super-group names to a hash reference. Each
3734    resulting hash reference contains the following fields.
3735    
3736    =over 4
3737    
3738    =item page
3739    
3740    The super-group's web page in the NMPDR.
3741    
3742    =item contents
3743    
3744    A list of 2-tuples, each containing a genus name followed by a species name
3745    (or 0, indicating all species). This list indicates which organisms belong
3746    in the super-group.
3747    
3748    =back
3749    
3750    =cut
3751    
3752    sub CheckGroupFile{
3753        # Get the parameters.
3754        my ($self) = @_;
3755        # Check to see if we already have this hash.
3756        if (! defined $self->{groupHash}) {
3757            # We don't, so we need to read it in.
3758            my %groupHash;
3759            # Read the group file.
3760            my @groupLines = Tracer::GetFile("$FIG_Config::sproutData/groups.tbl");
3761            # Loop through the list of sort-of groups.
3762            for my $groupLine (@groupLines) {
3763                my ($name, $page, @contents) = split /\t/, $groupLine;
3764                $groupHash{$name} = { page => $page,
3765                                      contents => [ map { [ split /\s*,\s*/, $_ ] } @contents ]
3766                                    };
3767            }
3768            # Save the hash.
3769            $self->{groupHash} = \%groupHash;
3770        }
3771        # Return the result.
3772        return %{$self->{groupHash}};
3773    }
3774    
3775    =head2 Virtual Methods
3776    
3777    =head3 CleanKeywords
3778    
3779        my $cleanedString = $sprout->CleanKeywords($searchExpression);
3780    
3781    Clean up a search expression or keyword list. This involves converting the periods
3782    in EC numbers to underscores, converting non-leading minus signs to underscores,
3783    a vertical bar or colon to an apostrophe, and forcing lower case for all alphabetic
3784    characters. In addition, any extra spaces are removed.
3785    
3786    =over 4
3787    
3788    =item searchExpression
3789    
3790    Search expression or keyword list to clean. Note that a search expression may
3791    contain boolean operators which need to be preserved. This includes leading
3792    minus signs.
3793    
3794    =item RETURN
3795    
3796    Cleaned expression or keyword list.
3797    
3798    =back
3799    
3800    =cut
3801    
3802    sub CleanKeywords {
3803        # Get the parameters.
3804        my ($self, $searchExpression) = @_;
3805        # Perform the standard cleanup.
3806        my $retVal = $self->ERDB::CleanKeywords($searchExpression);
3807        # Fix the periods in EC and TC numbers.
3808        $retVal =~ s/(\d+|\-)\.(\d+|-)\.(\d+|-)\.(\d+|-)/$1_$2_$3_$4/g;
3809        # Fix non-trailing periods.
3810        $retVal =~ s/\.(\w)/_$1/g;
3811        # Fix non-leading minus signs.
3812        $retVal =~ s/(\w)[\-]/$1_/g;
3813        # Fix the vertical bars and colons
3814        $retVal =~ s/(\w)[|:](\w)/$1'$2/g;
3815        # Return the result.
3816        return $retVal;
3817    }
3818    
3819  =head2 Internal Utility Methods  =head2 Internal Utility Methods
3820    
3821  =head3 ParseAssignment  =head3 ParseAssignment
# Line 3086  Line 3826 
3826    
3827  A functional assignment is always of the form  A functional assignment is always of the form
3828    
3829      C<set >I<YYYY>C< function to\n>I<ZZZZZ>      set YYYY function to
3830        ZZZZ
3831    
3832  where I<YYYY> is the B<user>, and I<ZZZZ> is the actual functional role. In most cases,  where I<YYYY> is the B<user>, and I<ZZZZ> is the actual functional role. In most cases,
3833  the user and the assigning user (from MadeAnnotation) will be the same, but that is  the user and the assigning user (from MadeAnnotation) will be the same, but that is
# Line 3132  Line 3873 
3873      }      }
3874      # If we have an assignment, we need to clean the function text. There may be      # If we have an assignment, we need to clean the function text. There may be
3875      # extra junk at the end added as a note from the user.      # extra junk at the end added as a note from the user.
3876      if (@retVal) {      if (defined( $retVal[1] )) {
3877          $retVal[1] =~ s/(\t\S)?\s*$//;          $retVal[1] =~ s/(\t\S)?\s*$//;
3878      }      }
3879      # Return the result list.      # Return the result list.
3880      return @retVal;      return @retVal;
3881  }  }
3882    
3883  =head3 FriendlyTimestamp  =head3 _CheckFeature
3884    
3885  Convert a time number to a user-friendly time stamp for display.      my $flag = $sprout->_CheckFeature($fid);
3886    
3887  This is a static method.  Return TRUE if the specified FID is probably an NMPDR feature ID, else FALSE.
3888    
3889  =over 4  =over 4
3890    
3891  =item timeValue  =item fid
3892    
3893  Numeric time value.  Feature ID to check.
3894    
3895  =item RETURN  =item RETURN
3896    
3897  Returns a string containing the same time in user-readable format.  Returns TRUE if the FID is for one of the NMPDR genomes, else FALSE.
3898    
3899  =back  =back
3900    
3901  =cut  =cut
3902    
3903  sub FriendlyTimestamp {  sub _CheckFeature {
3904      my ($timeValue) = @_;      # Get the parameters.
3905      my $retVal = localtime($timeValue);      my ($self, $fid) = @_;
3906      return $retVal;      # Insure we have a genome hash.
3907        if (! defined $self->{genomeHash}) {
3908            my %genomeHash = map { $_ => 1 } $self->GetFlat(['Genome'], "", [], 'Genome(id)');
3909            $self->{genomeHash} = \%genomeHash;
3910        }
3911        # Get the feature's genome ID.
3912        my ($genomeID) = FIGRules::ParseFeatureID($fid);
3913        # Return an indicator of whether or not the genome ID is in the hash.
3914        return ($self->{genomeHash}->{$genomeID} ? 1 : 0);
3915  }  }
3916    
3917  =head3 AddProperty  =head3 FriendlyTimestamp
3918    
3919  C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>  Convert a time number to a user-friendly time stamp for display.
3920    
3921  Add a new attribute value (Property) to a feature. In the SEED system, attributes can  This is a static method.
 be added to almost any object. In Sprout, they can only be added to features. In  
 Sprout, attributes are implemented using I<properties>. A property represents a key/value  
 pair. If the particular key/value pair coming in is not already in the database, a new  
 B<Property> record is created to hold it.  
3922    
3923  =over 4  =over 4
3924    
3925  =item peg  =item timeValue
   
 ID of the feature to which the attribute is to be replied.  
   
 =item key  
   
 Name of the attribute (key).  
   
 =item value  
3926    
3927  Value of the attribute.  Numeric time value.
3928    
3929  =item url  =item RETURN
3930    
3931  URL or text citation from which the property was obtained.  Returns a string containing the same time in user-readable format.
3932    
3933  =back  =back
3934    
3935  =cut  =cut
3936  #: Return Type ;  
3937  sub AddProperty {  sub FriendlyTimestamp {
3938      # Get the parameters.      my ($timeValue) = @_;
3939      my ($self, $featureID, $key, $value, $url) = @_;      my $retVal = localtime($timeValue);
3940      # Declare the variable to hold the desired property ID.      return $retVal;
     my $propID;  
     # Attempt to find a property record for this key/value pair.  
     my @properties = $self->GetFlat(['Property'],  
                                    "Property(property-name) = ? AND Property(property-value) = ?",  
                                    [$key, $value], 'Property(id)');  
     if (@properties) {  
         # Here the property is already in the database. We save its ID.  
         $propID = $properties[0];  
         # Here the property value does not exist. We need to generate an ID. It will be set  
         # to a number one greater than the maximum value in the database. This call to  
         # GetAll will stop after one record.  
         my @maxProperty = $self->GetAll(['Property'], "ORDER BY Property(id) DESC", [], ['Property(id)'],  
                                         1);  
         $propID = $maxProperty[0]->[0] + 1;  
         # Insert the new property value.  
         $self->Insert('Property', { 'property-name' => $key, 'property-value' => $value, id => $propID });  
     }  
     # Now we connect the incoming feature to the property.  
     $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });  
3941  }  }
3942    
3943    

Legend:
Removed from v.1.60  
changed lines
  Added in v.1.105

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3