[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.8, Thu Jan 27 00:30:20 2005 UTC revision 1.45, Thu Oct 20 10:20:27 2005 UTC
# Line 70  Line 70 
70    
71  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)
72    
73    * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE
74    
75  =back  =back
76    
77  For example, the following constructor call specifies a database named I<Sprout> and a user name of  For example, the following constructor call specifies a database named I<Sprout> and a user name of
# Line 86  Line 88 
88          # 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
89          # the incoming data.          # the incoming data.
90          my $optionTable = Tracer::GetOptions({          my $optionTable = Tracer::GetOptions({
91                                             dbType               => 'mysql',                     # database type                         dbType       => $FIG_Config::dbms,
92                                             dataDir              => 'Data',                      # data file directory                                                          # database type
93                                             xmlFileName  => 'SproutDBD.xml', # database definition file name                         dataDir      => $FIG_Config::sproutData,
94                                             userData             => 'root/',                     # user name and password                                                          # data file directory
95                                             port                 => 0,                           # database connection port                         xmlFileName  => "$FIG_Config::sproutData/SproutDBD.xml",
96                                                            # database definition file name
97                           userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
98                                                            # user name and password
99                           port         => $FIG_Config::dbport,
100                                                            # database connection port
101                                             maxSegmentLength => 4500,            # maximum feature segment length                                             maxSegmentLength => 4500,            # maximum feature segment length
102                                             maxSequenceLength => 8000,           # maximum contig sequence length                                             maxSequenceLength => 8000,           # maximum contig sequence length
103                           noDBOpen     => 0,               # 1 to suppress the database open
104                                            }, $options);                                            }, $options);
105          # Get the data directory.          # Get the data directory.
106          my $dataDir = $optionTable->{dataDir};          my $dataDir = $optionTable->{dataDir};
# Line 100  Line 108 
108          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;
109          my ($userName, $password) = ($1, $2);          my ($userName, $password) = ($1, $2);
110          # Connect to the database.          # Connect to the database.
111          my $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName, $password, $optionTable->{port});      my $dbh;
112        if (! $optionTable->{noDBOpen}) {
113            $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
114                                    $password, $optionTable->{port});
115        }
116          # Create the ERDB object.          # Create the ERDB object.
117          my $xmlFileName = "$optionTable->{xmlFileName}";          my $xmlFileName = "$optionTable->{xmlFileName}";
118          my $erdb = ERDB->new($dbh, $xmlFileName);          my $erdb = ERDB->new($dbh, $xmlFileName);
# Line 124  Line 136 
136  =cut  =cut
137  #: Return Type $;  #: Return Type $;
138  sub MaxSegment {  sub MaxSegment {
139          my $self = shift @_;      my ($self) = @_;
140          return $self->{_options}->{maxSegmentLength};          return $self->{_options}->{maxSegmentLength};
141  }  }
142    
# Line 139  Line 151 
151  =cut  =cut
152  #: Return Type $;  #: Return Type $;
153  sub MaxSequence {  sub MaxSequence {
154          my $self = shift @_;      my ($self) = @_;
155          return $self->{_options}->{maxSequenceLength};          return $self->{_options}->{maxSequenceLength};
156  }  }
157    
# Line 232  Line 244 
244    
245  sub Get {  sub Get {
246          # Get the parameters.          # Get the parameters.
247          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList) = @_;
         my ($objectNames, $filterClause, $parameterList) = @_;  
248          # We differ from the ERDB Get method in that the parameter list is passed in as a list reference          # We differ from the ERDB Get method in that the parameter list is passed in as a list reference
249          # rather than a list of parameters. The next step is to convert the parameters from a reference          # rather than a list of parameters. The next step is to convert the parameters from a reference
250          # to a real list. We can only do this if the parameters have been specified.          # to a real list. We can only do this if the parameters have been specified.
# Line 269  Line 280 
280    
281  sub GetEntity {  sub GetEntity {
282          # Get the parameters.          # Get the parameters.
283          my $self = shift @_;      my ($self, $entityType, $ID) = @_;
284          my ($entityType, $ID) = @_;      # Call the ERDB method.
285          # Create a query.      return $self->{_erdb}->GetEntity($entityType, $ID);
         my $query = $self->Get([$entityType], "$entityType(id) = ?", [$ID]);  
         # Get the first (and only) object.  
         my $retVal = $query->Fetch();  
         # Return the result.  
         return $retVal;  
286  }  }
287    
288  =head3 GetEntityValues  =head3 GetEntityValues
# Line 309  Line 315 
315  #: Return Type @;  #: Return Type @;
316  sub GetEntityValues {  sub GetEntityValues {
317          # Get the parameters.          # Get the parameters.
318          my $self = shift @_;      my ($self, $entityType, $ID, $fields) = @_;
319          my ($entityType, $ID, $fields) = @_;      # Call the ERDB method.
320          # Get the specified entity.      return $self->{_erdb}->GetEntityValues($entityType, $ID, $fields);
         my $entity = $self->GetEntity($entityType, $ID);  
         # Declare the return list.  
         my @retVal = ();  
         # If we found the entity, push the values into the return list.  
         if ($entity) {  
                 push @retVal, $entity->Values($fields);  
         }  
         # Return the result.  
         return @retVal;  
321  }  }
322    
323  =head3 ShowMetaData  =head3 ShowMetaData
# Line 341  Line 338 
338    
339  sub ShowMetaData {  sub ShowMetaData {
340          # Get the parameters.          # Get the parameters.
341          my $self = shift @_;      my ($self, $fileName) = @_;
         my ($fileName) = @_;  
342          # Compute the file name.          # Compute the file name.
343          my $options = $self->{_options};          my $options = $self->{_options};
344          # Call the show method on the underlying ERDB object.          # Call the show method on the underlying ERDB object.
# Line 382  Line 378 
378  #: Return Type %;  #: Return Type %;
379  sub Load {  sub Load {
380          # Get the parameters.          # Get the parameters.
381          my $self = shift @_;      my ($self, $rebuild) = @_;
         my ($rebuild) = @_;  
382          # Get the database object.          # Get the database object.
383          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
384          # Load the tables from the data directory.          # Load the tables from the data directory.
# Line 394  Line 389 
389    
390  =head3 LoadUpdate  =head3 LoadUpdate
391    
392  C<< my %stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>  C<< my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>
393    
394  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
395  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 426  Line 421 
421  #: Return Type $%;  #: Return Type $%;
422  sub LoadUpdate {  sub LoadUpdate {
423          # Get the parameters.          # Get the parameters.
424          my $self = shift @_;      my ($self, $truncateFlag, $tableList) = @_;
         my ($truncateFlag, $tableList) = @_;  
425          # Get the database object.          # Get the database object.
426          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
427          # Declare the return value.          # Declare the return value.
# Line 438  Line 432 
432          # Loop through the incoming table names.          # Loop through the incoming table names.
433          for my $tableName (@{$tableList}) {          for my $tableName (@{$tableList}) {
434                  # Find the table's file.                  # Find the table's file.
435                  my $fileName = "$dataDir/$tableName";          my $fileName = LoadFileName($dataDir, $tableName);
436                  if (! -e $fileName) {          if (! $fileName) {
437                          $fileName = "$fileName.dtx";              Trace("No load file found for $tableName in $dataDir.") if T(0);
438                  }          } else {
439                  # Attempt to load this table.                  # Attempt to load this table.
440                  my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);                  my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);
441                  # Accumulate the resulting statistics.                  # Accumulate the resulting statistics.
442                  $retVal->Accumulate($result);                  $retVal->Accumulate($result);
443          }          }
444        }
445          # Return the statistics.          # Return the statistics.
446          return $retVal;          return $retVal;
447  }  }
# Line 463  Line 458 
458  #: Return Type ;  #: Return Type ;
459  sub Build {  sub Build {
460          # Get the parameters.          # Get the parameters.
461          my $self = shift @_;      my ($self) = @_;
462          # Create the tables.          # Create the tables.
463          $self->{_erdb}->CreateTables;          $self->{_erdb}->CreateTables;
464  }  }
# Line 478  Line 473 
473  #: Return Type @;  #: Return Type @;
474  sub Genomes {  sub Genomes {
475          # Get the parameters.          # Get the parameters.
476          my $self = shift @_;      my ($self) = @_;
477          # Get all the genomes.          # Get all the genomes.
478          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');
479          # Return the list of IDs.          # Return the list of IDs.
# Line 508  Line 503 
503  #: Return Type $;  #: Return Type $;
504  sub GenusSpecies {  sub GenusSpecies {
505          # Get the parameters.          # Get the parameters.
506          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
507          # Get the data for the specified genome.          # Get the data for the specified genome.
508          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',
509                                                                                                                            'Genome(unique-characterization)']);                                                                                                                            'Genome(unique-characterization)']);
# Line 545  Line 539 
539  #: Return Type @;  #: Return Type @;
540  sub FeaturesOf {  sub FeaturesOf {
541          # Get the parameters.          # Get the parameters.
542          my $self = shift @_;      my ($self, $genomeID,$ftype) = @_;
         my ($genomeID,$ftype) = @_;  
543          # Get the features we want.          # Get the features we want.
544          my @features;          my @features;
545          if (!$ftype) {          if (!$ftype) {
# Line 590  Line 583 
583  =item RETURN  =item RETURN
584    
585  Returns a list of the feature's contig segments. The locations are returned as a list in a list  Returns a list of the feature's contig segments. The locations are returned as a list in a list
586  context and as a space-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context.
587    
588  =back  =back
589    
# Line 599  Line 592 
592  #: Return Type $;  #: Return Type $;
593  sub FeatureLocation {  sub FeatureLocation {
594          # Get the parameters.          # Get the parameters.
595          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
596          # Create a query for the feature locations.          # Create a query for the feature locations.
597          my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",          my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",
598                                                     [$featureID]);                                                     [$featureID]);
# Line 618  Line 610 
610                  if ($prevContig eq $contigID && $dir eq $prevDir) {                  if ($prevContig eq $contigID && $dir eq $prevDir) {
611                          # Here the new segment is in the same direction on the same contig. Insure the                          # Here the new segment is in the same direction on the same contig. Insure the
612                          # new segment's beginning is next to the old segment's end.                          # new segment's beginning is next to the old segment's end.
613                          if (($dir eq "-" && $beg == $prevBeg - $prevLen) ||              if ($dir eq "-" && $beg + $len == $prevBeg) {
614                                  ($dir eq "+" && $beg == $prevBeg + $prevLen)) {                  # Here we're merging two backward blocks, so we keep the new begin point
615                                  # Here we need to merge two segments. Adjust the beginning and length values                  # and adjust the length.
616                                  # to include both segments.                  $len += $prevLen;
617                    # Pop the old segment off. The new one will replace it later.
618                    pop @retVal;
619                } elsif ($dir eq "+" && $beg == $prevBeg + $prevLen) {
620                    # Here we need to merge two forward blocks. Adjust the beginning and
621                    # length values to include both segments.
622                                  $beg = $prevBeg;                                  $beg = $prevBeg;
623                                  $len += $prevLen;                                  $len += $prevLen;
624                                  # Pop the old segment off. The new one will replace it later.                                  # Pop the old segment off. The new one will replace it later.
# Line 630  Line 627 
627                  }                  }
628                  # Remember this specifier for the adjacent-segment test the next time through.                  # Remember this specifier for the adjacent-segment test the next time through.
629                  ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);                  ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);
630            # Compute the initial base pair.
631            my $start = ($dir eq "+" ? $beg : $beg + $len - 1);
632                  # Add the specifier to the list.                  # Add the specifier to the list.
633                  push @retVal, "${contigID}_$beg$dir$len";          push @retVal, "${contigID}_$start$dir$len";
634          }          }
635          # Return the list in the format indicated by the context.          # Return the list in the format indicated by the context.
636          return (wantarray ? @retVal : join(' ', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
637  }  }
638    
639  =head3 ParseLocation  =head3 ParseLocation
# Line 660  Line 659 
659  =cut  =cut
660  #: Return Type @;  #: Return Type @;
661  sub ParseLocation {  sub ParseLocation {
662          # Get the parameter.      # Get the parameter. Note that if we're called as an instance method, we ignore
663        # the first parameter.
664        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
665          my ($location) = @_;          my ($location) = @_;
666          # Parse it into segments.          # Parse it into segments.
667          $location =~ /^(.*)_(\d*)([+-_])(\d*)$/;      $location =~ /^(.+)_(\d+)([+\-_])(\d+)$/;
668          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);
669          # If the direction is an underscore, convert it to a + or -.          # If the direction is an underscore, convert it to a + or -.
670          if ($dir eq "_") {          if ($dir eq "_") {
# Line 679  Line 680 
680          return ($contigID, $start, $dir, $len);          return ($contigID, $start, $dir, $len);
681  }  }
682    
683    =head3 PointLocation
684    
685    C<< my $found = Sprout::PointLocation($location, $point); >>
686    
687    Return the offset into the specified location of the specified point on the contig. If
688    the specified point is before the location, a negative value will be returned. If it is
689    beyond the location, an undefined value will be returned. It is assumed that the offset
690    is for the location's contig. The location can either be new-style (using a C<+> or C<->
691    and a length) or old-style (using C<_> and start and end positions.
692    
693    =over 4
694    
695    =item location
696    
697    A location specifier (see L</FeatureLocation> for a description).
698    
699    =item point
700    
701    The offset into the contig of the point in which we're interested.
702    
703    =item RETURN
704    
705    Returns the offset inside the specified location of the specified point, a negative
706    number if the point is before the location, or an undefined value if the point is past
707    the location. If the length of the location is 0, this method will B<always> denote
708    that it is outside the location. The offset will always be relative to the left-most
709    position in the location.
710    
711    =back
712    
713    =cut
714    #: Return Type $;
715    sub PointLocation {
716        # Get the parameter. Note that if we're called as an instance method, we ignore
717        # the first parameter.
718        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
719        my ($location, $point) = @_;
720        # Parse out the location elements. Note that this works on both old-style and new-style
721        # locations.
722        my ($contigID, $start, $dir, $len) = ParseLocation($location);
723        # Declare the return variable.
724        my $retVal;
725        # Compute the offset. The computation is dependent on the direction of the location.
726        my $offset = (($dir == '+') ? $point - $start : $point - ($start - $len + 1));
727        # Return the offset if it's valid.
728        if ($offset < $len) {
729            $retVal = $offset;
730        }
731        # Return the offset found.
732        return $retVal;
733    }
734    
735  =head3 DNASeq  =head3 DNASeq
736    
737  C<< my $sequence = $sprout->DNASeq(\@locationList); >>  C<< my $sequence = $sprout->DNASeq(\@locationList); >>
# Line 704  Line 757 
757  #: Return Type $;  #: Return Type $;
758  sub DNASeq {  sub DNASeq {
759          # Get the parameters.          # Get the parameters.
760          my $self = shift @_;      my ($self, $locationList) = @_;
         my ($locationList) = @_;  
761          # Create the return string.          # Create the return string.
762          my $retVal = "";          my $retVal = "";
763          # Loop through the locations.          # Loop through the locations.
# Line 720  Line 772 
772                  # the start point is the ending. Note that in the latter case we must reverse the DNA string                  # the start point is the ending. Note that in the latter case we must reverse the DNA string
773                  # before putting it in the return value.                  # before putting it in the return value.
774                  my ($start, $stop);                  my ($start, $stop);
775            Trace("Parse of \"$location\" is $beg$dir$len.") if T(SDNA => 4);
776                  if ($dir eq "+") {                  if ($dir eq "+") {
777                          $start = $beg;                          $start = $beg;
778                          $stop = $beg + $len - 1;                          $stop = $beg + $len - 1;
779                  } else {                  } else {
780                          $start = $beg + $len + 1;              $start = $beg - $len + 1;
781                          $stop = $beg;                          $stop = $beg;
782                  }                  }
783            Trace("Looking for sequences containing $start through $stop.") if T(SDNA => 4);
784                  my $query = $self->Get(['IsMadeUpOf','Sequence'],                  my $query = $self->Get(['IsMadeUpOf','Sequence'],
785                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .
786                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",
# Line 738  Line 792 
792                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',
793                                                                     'IsMadeUpOf(len)']);                                                                     'IsMadeUpOf(len)']);
794                          my $stopPosition = $startPosition + $sequenceLength;                          my $stopPosition = $startPosition + $sequenceLength;
795                Trace("Sequence is from $startPosition to $stopPosition.") if T(SDNA => 4);
796                          # Figure out the start point and length of the relevant section.                          # Figure out the start point and length of the relevant section.
797                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);
798                          my $len = ($stopPosition <= $stop ? $stopPosition : $stop) - $startPosition - $pos1;              my $len1 = ($stopPosition < $stop ? $stopPosition : $stop) + 1 - $startPosition - $pos1;
799                Trace("Position is $pos1 for length $len1.") if T(SDNA => 4);
800                          # Add the relevant data to the location data.                          # Add the relevant data to the location data.
801                          $locationDNA .= substr($sequenceData, $pos1, $len);              $locationDNA .= substr($sequenceData, $pos1, $len1);
802                  }                  }
803                  # Add this location's data to the return string. Note that we may need to reverse it.                  # Add this location's data to the return string. Note that we may need to reverse it.
804                  if ($dir eq '+') {                  if ($dir eq '+') {
805                          $retVal .= $locationDNA;                          $retVal .= $locationDNA;
806                  } else {                  } else {
807                          $locationDNA = join('', reverse split //, $locationDNA);              $retVal .= FIG::reverse_comp($locationDNA);
                         $retVal .= $locationDNA;  
808                  }                  }
809          }          }
810          # Return the result.          # Return the result.
# Line 778  Line 833 
833  #: Return Type @;  #: Return Type @;
834  sub AllContigs {  sub AllContigs {
835          # Get the parameters.          # Get the parameters.
836          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
837          # Ask for the genome's Contigs.          # Ask for the genome's Contigs.
838          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],
839                                                                  'HasContig(to-link)');                                                                  'HasContig(to-link)');
# Line 809  Line 863 
863  #: Return Type $;  #: Return Type $;
864  sub ContigLength {  sub ContigLength {
865          # Get the parameters.          # Get the parameters.
866          my $self = shift @_;      my ($self, $contigID) = @_;
         my ($contigID) = @_;  
867          # Get the contig's last sequence.          # Get the contig's last sequence.
868          my $query = $self->Get(['IsMadeUpOf'],          my $query = $self->Get(['IsMadeUpOf'],
869                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",
# Line 821  Line 874 
874          # Set it from the sequence data, if any.          # Set it from the sequence data, if any.
875          if ($sequence) {          if ($sequence) {
876                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);
877                  $retVal = $start + $len;          $retVal = $start + $len - 1;
878        }
879        # Return the result.
880        return $retVal;
881    }
882    
883    =head3 ClusterPEGs
884    
885    C<< my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs); >>
886    
887    Cluster the PEGs in a list according to the cluster coding scheme of the specified
888    subsystem. In order for this to work properly, the subsystem object must have
889    been used recently to retrieve the PEGs using the B<get_pegs_from_cell> method.
890    This causes the cluster numbers to be pulled into the subsystem's color hash.
891    If a PEG is not found in the color hash, it will not appear in the output
892    sequence.
893    
894    =over 4
895    
896    =item sub
897    
898    Sprout subsystem object for the relevant subsystem, from the L</get_subsystem>
899    method.
900    
901    =item pegs
902    
903    Reference to the list of PEGs to be clustered.
904    
905    =item RETURN
906    
907    Returns a list of the PEGs, grouped into smaller lists by cluster number.
908    
909    =back
910    
911    =cut
912    #: Return Type $@@;
913    sub ClusterPEGs {
914        # Get the parameters.
915        my ($self, $sub, $pegs) = @_;
916        # Declare the return variable.
917        my $retVal = [];
918        # Loop through the PEGs, creating arrays for each cluster.
919        for my $pegID (@{$pegs}) {
920            my $clusterNumber = $sub->get_cluster_number($pegID);
921            # Only proceed if the PEG is in a cluster.
922            if ($clusterNumber >= 0) {
923                # Push this PEG onto the sub-list for the specified cluster number.
924                push @{$retVal->[$clusterNumber]}, $pegID;
925            }
926          }          }
927          # Return the result.          # Return the result.
928          return $retVal;          return $retVal;
# Line 852  Line 953 
953  Returns a three-element list. The first element is a list of feature IDs for the features that  Returns a three-element list. The first element is a list of feature IDs for the features that
954  overlap the region of interest. The second and third elements are the minimum and maximum  overlap the region of interest. The second and third elements are the minimum and maximum
955  locations of the features provided on the specified contig. These may extend outside  locations of the features provided on the specified contig. These may extend outside
956  the start and stop values.  the start and stop values. The first element (that is, the list of features) is sorted
957    roughly by location.
958    
959  =back  =back
960    
961  =cut  =cut
962  #: Return Type @;  #: Return Type @@;
963  sub GenesInRegion {  sub GenesInRegion {
964          # Get the parameters.          # Get the parameters.
965          my $self = shift @_;      my ($self, $contigID, $start, $stop) = @_;
         my ($contigID, $start, $stop) = @_;  
966          # Get the maximum segment length.          # Get the maximum segment length.
967          my $maximumSegmentLength = $self->MaxSegment;          my $maximumSegmentLength = $self->MaxSegment;
968          # Create a hash to receive the feature list. We use a hash so that we can eliminate          # Create a hash to receive the feature list. We use a hash so that we can eliminate
969          # duplicates easily.      # duplicates easily. The hash key will be the feature ID. The value will be a two-element
970        # containing the minimum and maximum offsets. We will use the offsets to sort the results
971        # when we're building the result set.
972          my %featuresFound = ();          my %featuresFound = ();
973          # Prime the values we'll use for the returned beginning and end.          # Prime the values we'll use for the returned beginning and end.
974          my ($min, $max) = ($self->ContigLength($contigID), 0);      my @initialMinMax = ($self->ContigLength($contigID), 0);
975        my ($min, $max) = @initialMinMax;
976          # Create a table of parameters for each query. Each query looks for features travelling in          # Create a table of parameters for each query. Each query looks for features travelling in
977          # 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,
978          # 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
# Line 898  Line 1002 
1002                                          $found = 1;                                          $found = 1;
1003                                  }                                  }
1004                          } elsif ($dir eq '-') {                          } elsif ($dir eq '-') {
1005                                  $end = $beg - $len;                  # Note we switch things around so that the beginning is to the left of the
1006                                  if ($end <= $stop) {                  # ending.
1007                    ($beg, $end) = ($beg - $len, $beg);
1008                    if ($beg <= $stop) {
1009                                          # Denote we found a useful feature.                                          # Denote we found a useful feature.
1010                                          $found = 1;                                          $found = 1;
1011                                  }                                  }
1012                          }                          }
1013                          if ($found) {                          if ($found) {
1014                                  # Here we need to record the feature and update the minimum and maximum.                  # Here we need to record the feature and update the minima and maxima. First,
1015                                  $featuresFound{$featureID} = 1;                  # get the current entry for the specified feature.
1016                                  if ($beg < $min) { $min = $beg; }                  my ($loc1, $loc2) = (exists $featuresFound{$featureID} ? @{$featuresFound{$featureID}} :
1017                                  if ($end < $min) { $min = $end; }                                       @initialMinMax);
1018                                  if ($beg > $max) { $max = $beg; }                  # Merge the current segment's begin and end into the feature begin and end and the
1019                                  if ($end > $max) { $max = $end; }                  # global min and max.
1020                    if ($beg < $loc1) {
1021                        $loc1 = $beg;
1022                        $min = $beg if $beg < $min;
1023                    }
1024                    if ($end > $loc2) {
1025                        $loc2 = $end;
1026                        $max = $end if $end > $max;
1027                    }
1028                    # Store the entry back into the hash table.
1029                    $featuresFound{$featureID} = [$loc1, $loc2];
1030                          }                          }
1031                  }                  }
1032          }          }
1033          # Compute a list of the IDs for the features found.      # Now we must compute the list of the IDs for the features found. We start with a list
1034          my @list = (sort (keys %featuresFound));      # of midpoints / feature ID pairs. (It's not really a midpoint, it's twice the midpoint,
1035        # but the result of the sort will be the same.)
1036        my @list = map { [$featuresFound{$_}->[0] + $featuresFound{$_}->[1], $_] } keys %featuresFound;
1037        # Now we sort by midpoint and yank out the feature IDs.
1038        my @retVal = map { $_->[1] } sort { $a->[0] <=> $b->[0] } @list;
1039          # Return it along with the min and max.          # Return it along with the min and max.
1040          return (\@list, $min, $max);      return (\@retVal, $min, $max);
1041  }  }
1042    
1043  =head3 FType  =head3 FType
# Line 943  Line 1063 
1063  #: Return Type $;  #: Return Type $;
1064  sub FType {  sub FType {
1065          # Get the parameters.          # Get the parameters.
1066          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1067          # Get the specified feature's type.          # Get the specified feature's type.
1068          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);
1069          # Return the result.          # Return the result.
# Line 953  Line 1072 
1072    
1073  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1074    
1075  C<< my @descriptors = $sprout->FeatureAnnotations($featureID); >>  C<< my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag); >>
1076    
1077  Return the annotations of a feature.  Return the annotations of a feature.
1078    
# Line 963  Line 1082 
1082    
1083  ID of the feature whose annotations are desired.  ID of the feature whose annotations are desired.
1084    
1085    =item rawFlag
1086    
1087    If TRUE, the annotation timestamps will be returned in raw form; otherwise, they
1088    will be returned in human-readable form.
1089    
1090  =item RETURN  =item RETURN
1091    
1092  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.
1093    
1094  * B<featureID> ID of the relevant feature.  * B<featureID> ID of the relevant feature.
1095    
1096  * B<timeStamp> time the annotation was made, in user-friendly format.  * B<timeStamp> time the annotation was made.
1097    
1098  * B<user> ID of the user who made the annotation  * B<user> ID of the user who made the annotation
1099    
# Line 981  Line 1105 
1105  #: Return Type @%;  #: Return Type @%;
1106  sub FeatureAnnotations {  sub FeatureAnnotations {
1107          # Get the parameters.          # Get the parameters.
1108          my $self = shift @_;      my ($self, $featureID, $rawFlag) = @_;
         my ($featureID) = @_;  
1109          # Create a query to get the feature's annotations and the associated users.          # Create a query to get the feature's annotations and the associated users.
1110          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1111                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);
# Line 995  Line 1118 
1118                          $annotation->Values(['IsTargetOfAnnotation(from-link)',                          $annotation->Values(['IsTargetOfAnnotation(from-link)',
1119                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',
1120                                                                   'Annotation(annotation)']);                                                                   'Annotation(annotation)']);
1121            # Convert the time, if necessary.
1122            if (! $rawFlag) {
1123                $timeStamp = FriendlyTimestamp($timeStamp);
1124            }
1125                  # Assemble them into a hash.                  # Assemble them into a hash.
1126          my $annotationHash = { featureID => $featureID,          my $annotationHash = { featureID => $featureID,
1127                                 timeStamp => FriendlyTimestamp($timeStamp),                                 timeStamp => $timeStamp,
1128                                                             user => $user, text => $text };                                                             user => $user, text => $text };
1129                  # Add it to the return list.                  # Add it to the return list.
1130                  push @retVal, $annotationHash;                  push @retVal, $annotationHash;
# Line 1011  Line 1138 
1138  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>
1139    
1140  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
1141  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,
1142  It has the format "XXXX\nset XXXX function to\nYYYYY". In this instance, XXXX is the user ID  Functional assignments are described in the L</ParseAssignment> function. Its worth noting that
1143  and YYYYY is the functional assignment text. Its worth noting that we cannot filter on the content  we cannot filter on the content of the annotation itself because it's a text field; however,
1144  of the annotation itself because it's a text field; however, this is not a big problem because most  this is not a big problem because most features only have a small number of annotations.
1145  features only have a small number of annotations. Finally, if a single user has multiple  Finally, if a single user has multiple functional assignments, we will only keep the most
1146  functional assignments, we will only keep the most recent one.  recent one.
1147    
1148  =over 4  =over 4
1149    
# Line 1034  Line 1161 
1161  #: Return Type %;  #: Return Type %;
1162  sub AllFunctionsOf {  sub AllFunctionsOf {
1163          # Get the parameters.          # Get the parameters.
1164          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1165          # Get all of the feature's annotations.          # Get all of the feature's annotations.
1166      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],
1167                                                      "IsTargetOfAnnotation(from-link) = ?",                                                      "IsTargetOfAnnotation(from-link) = ?",
# Line 1051  Line 1177 
1177          # Get the annotation fields.          # Get the annotation fields.
1178          my ($timeStamp, $text) = @{$annotation};          my ($timeStamp, $text) = @{$annotation};
1179                  # Check to see if this is a functional assignment.                  # Check to see if this is a functional assignment.
1180                  my ($user, $function) = ParseAssignment($text);          my ($user, $function) = _ParseAssignment($text);
1181          if ($user && ! exists $timeHash{$user}) {          if ($user && ! exists $timeHash{$user}) {
1182              # Here it is a functional assignment and there has been no              # Here it is a functional assignment and there has been no
1183              # previous assignment for this user, so we stuff it in the              # previous assignment for this user, so we stuff it in the
# Line 1073  Line 1199 
1199    
1200  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
1201  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1202  assignment is a type of annotation. It has the format "XXXX\nset XXXX function to\nYYYYY". In this  assignment is a type of annotation. The format of an assignment is described in
1203  instance, XXXX is the user ID and YYYYY is the functional assignment text. Its worth noting that  L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1204  we cannot filter on the content of the annotation itself because it's a text field; however, this  annotation itself because it's a text field; however, this is not a big problem because
1205  is not a big problem because most features only have a small number of annotations.  most features only have a small number of annotations.
1206    
1207  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
1208  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 1108  Line 1234 
1234  #: Return Type $;  #: Return Type $;
1235  sub FunctionOf {  sub FunctionOf {
1236          # Get the parameters.          # Get the parameters.
1237          my $self = shift @_;      my ($self, $featureID, $userID) = @_;
         my ($featureID, $userID) = @_;  
1238      # Declare the return value.      # Declare the return value.
1239      my $retVal;      my $retVal;
1240      # Determine the ID type.      # Determine the ID type.
# Line 1146  Line 1271 
1271              # Get the annotation text.              # Get the annotation text.
1272              my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);              my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);
1273              # Check to see if this is a functional assignment for a trusted user.              # Check to see if this is a functional assignment for a trusted user.
1274              my ($user, $type, $function) = split(/\n/, $text);              my ($user, $function) = _ParseAssignment($text);
1275              if ($type =~ m/^set $user function to$/i) {              if ($user) {
1276                  # Here it is a functional assignment. Check the time and the user                  # Here it is a functional assignment. Check the time and the user
1277                  # name. The time must be recent and the user must be trusted.                  # name. The time must be recent and the user must be trusted.
1278                  if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {                  if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {
# Line 1166  Line 1291 
1291          return $retVal;          return $retVal;
1292  }  }
1293    
1294    =head3 FunctionsOf
1295    
1296    C<< my @functionList = $sprout->FunctionOf($featureID, $userID); >>
1297    
1298    Return the functional assignments of a particular feature.
1299    
1300    The functional assignment is handled differently depending on the type of feature. If
1301    the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1302    assignment is a type of annotation. The format of an assignment is described in
1303    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1304    annotation itself because it's a text field; however, this is not a big problem because
1305    most features only have a small number of annotations.
1306    
1307    If the feature is B<not> identified by a FIG ID, then the functional assignment
1308    information is taken from the B<ExternalAliasFunc> table. If the table does
1309    not contain an entry for the feature, an empty list is returned.
1310    
1311    =over 4
1312    
1313    =item featureID
1314    
1315    ID of the feature whose functional assignments are desired.
1316    
1317    =item RETURN
1318    
1319    Returns a list of 2-tuples, each consisting of a user ID and the text of an assignment by
1320    that user.
1321    
1322    =back
1323    
1324    =cut
1325    #: Return Type @@;
1326    sub FunctionsOf {
1327        # Get the parameters.
1328        my ($self, $featureID) = @_;
1329        # Declare the return value.
1330        my @retVal = ();
1331        # Determine the ID type.
1332        if ($featureID =~ m/^fig\|/) {
1333            # Here we have a FIG feature ID. We must build the list of trusted
1334            # users.
1335            my %trusteeTable = ();
1336            # Build a query for all of the feature's annotations, sorted by date.
1337            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],
1338                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1339                                   [$featureID]);
1340            my $timeSelected = 0;
1341            # Loop until we run out of annotations.
1342            while (my $annotation = $query->Fetch()) {
1343                # Get the annotation text.
1344                my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);
1345                # Check to see if this is a functional assignment for a trusted user.
1346                my ($user, $function) = _ParseAssignment($text);
1347                if ($user) {
1348                    # Here it is a functional assignment.
1349                    push @retVal, [$user, $function];
1350                }
1351            }
1352        } else {
1353            # Here we have a non-FIG feature ID. In this case the user ID does not
1354            # matter. We simply get the information from the External Alias Function
1355            # table.
1356            push @retVal, $self->GetEntityValues('ExternalAliasFunc', $featureID, ['ExternalAliasFunc(func)']);
1357        }
1358        # Return the assignments found.
1359        return @retVal;
1360    }
1361    
1362  =head3 BBHList  =head3 BBHList
1363    
1364  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>
# Line 1185  Line 1378 
1378    
1379  =item RETURN  =item RETURN
1380    
1381  Returns a reference to a hash that maps the IDs of the incoming features to the IDs of  Returns a reference to a hash that maps the IDs of the incoming features to the best hits
1382  their best hits.  on the target genome.
1383    
1384  =back  =back
1385    
# Line 1194  Line 1387 
1387  #: Return Type %;  #: Return Type %;
1388  sub BBHList {  sub BBHList {
1389          # Get the parameters.          # Get the parameters.
1390          my $self = shift @_;      my ($self, $genomeID, $featureList) = @_;
         my ($genomeID, $featureList) = @_;  
1391          # Create the return structure.          # Create the return structure.
1392          my %retVal = ();          my %retVal = ();
1393          # Loop through the incoming features.          # Loop through the incoming features.
# Line 1204  Line 1396 
1396                  my $query = $self->Get(['IsBidirectionalBestHitOf'],                  my $query = $self->Get(['IsBidirectionalBestHitOf'],
1397                                                             "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",                                                             "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",
1398                                                             [$featureID, $genomeID]);                                                             [$featureID, $genomeID]);
1399                  # Look for the best hit.          # Peel off the BBHs found.
1400                  my $bbh = $query->Fetch;          my @found = ();
1401                  if ($bbh) {          while (my $bbh = $query->Fetch) {
1402                          my ($targetFeature) = $bbh->Value('IsBidirectionalBestHitOf(to-link)');              push @found, $bbh->Value('IsBidirectionalBestHitOf(to-link)');
                         $retVal{$featureID} = $targetFeature;  
1403                  }                  }
1404            $retVal{$featureID} = \@found;
1405          }          }
1406          # Return the mapping.          # Return the mapping.
1407          return \%retVal;          return \%retVal;
1408  }  }
1409    
1410    =head3 SimList
1411    
1412    C<< my %similarities = $sprout->SimList($featureID, $count); >>
1413    
1414    Return a list of the similarities to the specified feature.
1415    
1416    Sprout does not support real similarities, so this method just returns the bidirectional
1417    best hits.
1418    
1419    =over 4
1420    
1421    =item featureID
1422    
1423    ID of the feature whose similarities are desired.
1424    
1425    =item count
1426    
1427    Maximum number of similar features to be returned, or C<0> to return them all.
1428    
1429    =back
1430    
1431    =cut
1432    #: Return Type %;
1433    sub SimList {
1434        # Get the parameters.
1435        my ($self, $featureID, $count) = @_;
1436        # Ask for the best hits.
1437        my @lists = $self->GetAll(['IsBidirectionalBestHitOf'],
1438                                  "IsBidirectionalBestHitOf(from-link) = ? ORDER BY IsBidirectionalBestHitOf(score) DESC",
1439                                  [$featureID], ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(score)'],
1440                                  $count);
1441        # Create the return value.
1442        my %retVal = ();
1443        for my $tuple (@lists) {
1444            $retVal{$tuple->[0]} = $tuple->[1];
1445        }
1446        # Return the result.
1447        return %retVal;
1448    }
1449    
1450    
1451    
1452    =head3 IsComplete
1453    
1454    C<< my $flag = $sprout->IsComplete($genomeID); >>
1455    
1456    Return TRUE if the specified genome is complete, else FALSE.
1457    
1458    =over 4
1459    
1460    =item genomeID
1461    
1462    ID of the genome whose completeness status is desired.
1463    
1464    =item RETURN
1465    
1466    Returns TRUE if the genome is complete, FALSE if it is incomplete, and C<undef> if it is
1467    not found.
1468    
1469    =back
1470    
1471    =cut
1472    #: Return Type $;
1473    sub IsComplete {
1474        # Get the parameters.
1475        my ($self, $genomeID) = @_;
1476        # Declare the return variable.
1477        my $retVal;
1478        # Get the genome's data.
1479        my $genomeData = $self->GetEntity('Genome', $genomeID);
1480        if ($genomeData) {
1481            # The genome exists, so get the completeness flag.
1482            ($retVal) = $genomeData->Value('complete');
1483        }
1484        # Return the result.
1485        return $retVal;
1486    }
1487    
1488  =head3 FeatureAliases  =head3 FeatureAliases
1489    
1490  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>
# Line 1238  Line 1508 
1508  #: Return Type @;  #: Return Type @;
1509  sub FeatureAliases {  sub FeatureAliases {
1510          # Get the parameters.          # Get the parameters.
1511          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1512          # Get the desired feature's aliases          # Get the desired feature's aliases
1513          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);
1514          # Return the result.          # Return the result.
# Line 1269  Line 1538 
1538  #: Return Type $;  #: Return Type $;
1539  sub GenomeOf {  sub GenomeOf {
1540          # Get the parameters.          # Get the parameters.
1541          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1542          # Create a query to find the genome associated with the feature.          # Create a query to find the genome associated with the feature.
1543          my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);          my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);
1544          # Declare the return value.          # Declare the return value.
# Line 1306  Line 1574 
1574  #: Return Type %;  #: Return Type %;
1575  sub CoupledFeatures {  sub CoupledFeatures {
1576          # Get the parameters.          # Get the parameters.
1577          my $self = shift @_;      my ($self, $featureID) = @_;
1578          my ($featureID) = @_;      # Create a query to retrieve the functionally-coupled features.
1579          # Create a query to retrieve the functionally-coupled features. Note that we depend on the      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],
1580          # fact that the functional coupling is physically paired. If (A,B) is in the database, then                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);
         # (B,A) will also be found.  
         my $query = $self->Get(['IsClusteredOnChromosomeWith'],  
                                                    "IsClusteredOnChromosomeWith(from-link) = ?", [$featureID]);  
1581          # This value will be set to TRUE if we find at least one coupled feature.          # This value will be set to TRUE if we find at least one coupled feature.
1582          my $found = 0;          my $found = 0;
1583          # Create the return hash.          # Create the return hash.
1584          my %retVal = ();          my %retVal = ();
1585          # Retrieve the relationship records and store them in the hash.          # Retrieve the relationship records and store them in the hash.
1586          while (my $clustering = $query->Fetch()) {          while (my $clustering = $query->Fetch()) {
1587                  my ($otherFeatureID, $score) = $clustering->Values(['IsClusteredOnChromosomeWith(to-link)',          # Get the ID and score of the coupling.
1588                                                                      'IsClusteredOnChromosomeWith(score)']);          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',
1589                                                            'Coupling(score)']);
1590            # The coupling ID contains the two feature IDs separated by a space. We use
1591            # this information to find the ID of the other feature.
1592            my ($fid1, $fid2) = split / /, $couplingID;
1593            my $otherFeatureID = ($featureID eq $fid1 ? $fid2 : $fid1);
1594            # Attach the other feature's score to its ID.
1595                  $retVal{$otherFeatureID} = $score;                  $retVal{$otherFeatureID} = $score;
1596                  $found = 1;                  $found = 1;
1597          }          }
# Line 1333  Line 1604 
1604          return %retVal;          return %retVal;
1605  }  }
1606    
1607    =head3 CouplingEvidence
1608    
1609    C<< my @evidence = $sprout->CouplingEvidence($peg1, $peg2); >>
1610    
1611    Return the evidence for a functional coupling.
1612    
1613    A pair of features is considered evidence of a coupling between two other
1614    features if they occur close together on a contig and both are similar to
1615    the coupled features. So, if B<A1> and B<A2> are close together on a contig,
1616    B<B1> and B<B2> are considered evidence for the coupling if (1) B<B1> and
1617    B<B2> are close together, (2) B<B1> is similar to B<A1>, and (3) B<B2> is
1618    similar to B<A2>.
1619    
1620    The score of a coupling is determined by the number of pieces of evidence
1621    that are considered I<representative>. If several evidence items belong to
1622    a group of genomes that are close to each other, only one of those items
1623    is considered representative. The other evidence items are presumed to be
1624    there because of the relationship between the genomes rather than because
1625    the two proteins generated by the features have a related functionality.
1626    
1627    Each evidence item is returned as a three-tuple in the form C<[>I<$peg1a>C<,>
1628    I<$peg2a>C<,> I<$rep>C<]>, where I<$peg1a> is similar to I<$peg1>, I<$peg2a>
1629    is similar to I<$peg2>, and I<$rep> is TRUE if the evidence is representative
1630    and FALSE otherwise.
1631    
1632    =over 4
1633    
1634    =item peg1
1635    
1636    ID of the feature of interest.
1637    
1638    =item peg2
1639    
1640    ID of a feature functionally coupled to the feature of interest.
1641    
1642    =item RETURN
1643    
1644    Returns a list of 3-tuples. Each tuple consists of a feature similar to the feature
1645    of interest, a feature similar to the functionally coupled feature, and a flag
1646    that is TRUE for a representative piece of evidence and FALSE otherwise.
1647    
1648    =back
1649    
1650    =cut
1651    #: Return Type @@;
1652    sub CouplingEvidence {
1653        # Get the parameters.
1654        my ($self, $peg1, $peg2) = @_;
1655        # Declare the return variable.
1656        my @retVal = ();
1657        # Our first task is to find out the nature of the coupling: whether or not
1658        # it exists, its score, and whether the features are stored in the same
1659        # order as the ones coming in.
1660        my ($couplingID, $inverted, $score) = $self->GetCoupling($peg1, $peg2);
1661        # Only proceed if a coupling exists.
1662        if ($couplingID) {
1663            # Determine the ordering to place on the evidence items. If we're
1664            # inverted, we want to see feature 2 before feature 1 (descending); otherwise,
1665            # we want feature 1 before feature 2 (normal).
1666            Trace("Coupling evidence for ($peg1, $peg2) with inversion flag $inverted.") if T(Coupling => 4);
1667            my $ordering = ($inverted ? "DESC" : "");
1668            # Get the coupling evidence.
1669            my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],
1670                                              "IsEvidencedBy(from-link) = ? ORDER BY PCH(id), UsesAsEvidence(pos) $ordering",
1671                                              [$couplingID],
1672                                              ['PCH(used)', 'UsesAsEvidence(to-link)']);
1673            # Loop through the evidence items. Each piece of evidence is represented by two
1674            # positions in the evidence list, one for each feature on the other side of the
1675            # evidence link. If at some point we want to generalize to couplings with
1676            # more than two positions, this section of code will need to be re-done.
1677            while (@evidenceList > 0) {
1678                my $peg1Data = shift @evidenceList;
1679                my $peg2Data = shift @evidenceList;
1680                Trace("Peg 1 is " . $peg1Data->[1] . " and Peg 2 is " . $peg2Data->[1] . ".") if T(Coupling => 4);
1681                push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];
1682            }
1683            Trace("Last index in evidence result is is $#retVal.") if T(Coupling => 4);
1684        }
1685        # Return the result.
1686        return @retVal;
1687    }
1688    
1689    =head3 GetCoupling
1690    
1691    C<< my ($couplingID, $inverted, $score) = $sprout->GetCoupling($peg1, $peg2); >>
1692    
1693    Return the coupling (if any) for the specified pair of PEGs. If a coupling
1694    exists, we return the coupling ID along with an indicator of whether the
1695    coupling is stored as C<(>I<$peg1>C<, >I<$peg2>C<)> or C<(>I<$peg2>C<, >I<$peg1>C<)>.
1696    In the second case, we say the coupling is I<inverted>. The importance of an
1697    inverted coupling is that the PEGs in the evidence will appear in reverse order.
1698    
1699    =over 4
1700    
1701    =item peg1
1702    
1703    ID of the feature of interest.
1704    
1705    =item peg2
1706    
1707    ID of the potentially coupled feature.
1708    
1709    =item RETURN
1710    
1711    Returns a three-element list. The first element contains the database ID of
1712    the coupling. The second element is FALSE if the coupling is stored in the
1713    database in the caller specified order and TRUE if it is stored in the
1714    inverted order. The third element is the coupling's score. If the coupling
1715    does not exist, all three list elements will be C<undef>.
1716    
1717    =back
1718    
1719    =cut
1720    #: Return Type $%@;
1721    sub GetCoupling {
1722        # Get the parameters.
1723        my ($self, $peg1, $peg2) = @_;
1724        # Declare the return values. We'll start with the coupling ID and undefine the
1725        # flag and score until we have more information.
1726        my ($retVal, $inverted, $score) = (CouplingID($peg1, $peg2), undef, undef);
1727        # Find the coupling data.
1728        my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],
1729                                     "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",
1730                                     [$retVal], ["ParticipatesInCoupling(from-link)", "Coupling(score)"]);
1731        # Check to see if we found anything.
1732        if (!@pegs) {
1733            Trace("No coupling found.") if T(Coupling => 4);
1734            # No coupling, so undefine the return value.
1735            $retVal = undef;
1736        } else {
1737            # We have a coupling! Get the score and check for inversion.
1738            $score = $pegs[0]->[1];
1739            my $firstFound = $pegs[0]->[0];
1740            $inverted = ($firstFound ne $peg1);
1741            Trace("Coupling score is $score. First peg is $firstFound, peg 1 is $peg1.") if T(Coupling => 4);
1742        }
1743        # Return the result.
1744        return ($retVal, $inverted, $score);
1745    }
1746    
1747    =head3 CouplingID
1748    
1749    C<< my $couplingID = Sprout::CouplingID($peg1, $peg2); >>
1750    
1751    Return the coupling ID for a pair of feature IDs.
1752    
1753    The coupling ID is currently computed by joining the feature IDs in
1754    sorted order with a space. Client modules (that is, modules which
1755    use Sprout) should not, however, count on this always being the
1756    case. This method provides a way for abstracting the concept of a
1757    coupling ID. All that we know for sure about it is that it can be
1758    generated easily from the feature IDs and the order of the IDs
1759    in the parameter list does not matter (i.e. C<CouplingID("a1", "b1")>
1760    will have the same value as C<CouplingID("b1", "a1")>.
1761    
1762    =over 4
1763    
1764    =item peg1
1765    
1766    First feature of interest.
1767    
1768    =item peg2
1769    
1770    Second feature of interest.
1771    
1772    =item RETURN
1773    
1774    Returns the ID that would be used to represent a functional coupling of
1775    the two specified PEGs.
1776    
1777    =back
1778    
1779    =cut
1780    #: Return Type $;
1781    sub CouplingID {
1782        return join " ", sort @_;
1783    }
1784    
1785  =head3 GetEntityTypes  =head3 GetEntityTypes
1786    
1787  C<< my @entityList = $sprout->GetEntityTypes(); >>  C<< my @entityList = $sprout->GetEntityTypes(); >>
# Line 1343  Line 1792 
1792  #: Return Type @;  #: Return Type @;
1793  sub GetEntityTypes {  sub GetEntityTypes {
1794          # Get the parameters.          # Get the parameters.
1795          my $self = shift @_;      my ($self) = @_;
1796          # Get the underlying database object.          # Get the underlying database object.
1797          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
1798          # Get its entity type list.          # Get its entity type list.
# Line 1394  Line 1843 
1843                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {
1844                          # Here we have a new header. Store the current sequence if we have one.                          # Here we have a new header. Store the current sequence if we have one.
1845                          if ($id) {                          if ($id) {
1846                                  $retVal{$id} = $sequence;                  $retVal{$id} = lc $sequence;
1847                          }                          }
1848                          # Clear the sequence accumulator and save the new ID.                          # Clear the sequence accumulator and save the new ID.
1849                          ($id, $sequence) = ("$prefix$1", "");                          ($id, $sequence) = ("$prefix$1", "");
1850                  } else {                  } else {
1851                          # Here we have a data line, so we add it to the sequence accumulator.                          # Here we have a data line, so we add it to the sequence accumulator.
1852                          # First, we get the actual data out.              # First, we get the actual data out. Note that we normalize to lower
1853                # case.
1854                          $line =~ /^\s*(.*?)(\s|\n)/;                          $line =~ /^\s*(.*?)(\s|\n)/;
1855                          $sequence .= $1;                          $sequence .= $1;
1856                  }                  }
1857          }          }
1858          # Flush out the last sequence (if any).          # Flush out the last sequence (if any).
1859          if ($sequence) {          if ($sequence) {
1860                  $retVal {$id} = $sequence;          $retVal{$id} = lc $sequence;
1861          }          }
1862        # Close the file.
1863        close FASTAFILE;
1864          # Return the hash constructed from the file.          # Return the hash constructed from the file.
1865          return %retVal;          return %retVal;
1866  }  }
# Line 1419  Line 1871 
1871    
1872  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
1873  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
1874  gene. The old format is I<contig>_I<beg>_I<end>.  gene. The old format is I<contig>_I<beg>_I<end>. If a feature is in the new format already,
1875    it will not be changed; otherwise, it will be converted. This method can also be used to
1876    perform the reverse task-- insuring that all the locations are in the old format.
1877    
1878  =over 4  =over 4
1879    
# Line 1446  Line 1900 
1900  #: Return Type @;  #: Return Type @;
1901  sub FormatLocations {  sub FormatLocations {
1902          # Get the parameters.          # Get the parameters.
1903          my $self = shift @_;      my ($self, $prefix, $locations, $oldFormat) = @_;
         my ($prefix, $locations, $oldFormat) = @_;  
1904          # Create the return list.          # Create the return list.
1905          my @retVal = ();          my @retVal = ();
1906          # Check to see if any locations were passed in.          # Check to see if any locations were passed in.
1907          if ($locations eq '') {          if ($locations eq '') {
1908              confess "No locations specified.";          Confess("No locations specified.");
1909          } else {          } else {
1910                  # Loop through the locations, converting them to the new format.                  # Loop through the locations, converting them to the new format.
1911                  for my $location (@{$locations}) {                  for my $location (@{$locations}) {
# Line 1487  Line 1940 
1940    
1941  sub DumpData {  sub DumpData {
1942          # Get the parameters.          # Get the parameters.
1943          my $self = shift @_;      my ($self) = @_;
1944          # Get the data directory name.          # Get the data directory name.
1945          my $outputDirectory = $self->{_options}->{dataDir};          my $outputDirectory = $self->{_options}->{dataDir};
1946          # Dump the relations.          # Dump the relations.
# Line 1503  Line 1956 
1956  =cut  =cut
1957  #: Return Type $;  #: Return Type $;
1958  sub XMLFileName {  sub XMLFileName {
1959          my $self = shift @_;      my ($self) = @_;
1960          return $self->{_xmlName};          return $self->{_xmlName};
1961  }  }
1962    
# Line 1523  Line 1976 
1976  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
1977  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>.
1978    
1979  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence = 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence => 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>
1980    
1981  =over 4  =over 4
1982    
# Line 1541  Line 1994 
1994  #: Return Type ;  #: Return Type ;
1995  sub Insert {  sub Insert {
1996          # Get the parameters.          # Get the parameters.
1997          my $self = shift @_;      my ($self, $objectType, $fieldHash) = @_;
         my ($objectType, $fieldHash) = @_;  
1998          # Call the underlying method.          # Call the underlying method.
1999          $self->{_erdb}->InsertObject($objectType, $fieldHash);          $self->{_erdb}->InsertObject($objectType, $fieldHash);
2000  }  }
# Line 1583  Line 2035 
2035  #: Return Type $;  #: Return Type $;
2036  sub Annotate {  sub Annotate {
2037          # Get the parameters.          # Get the parameters.
2038          my $self = shift @_;      my ($self, $fid, $timestamp, $user, $text) = @_;
         my ($fid, $timestamp, $user, $text) = @_;  
2039          # Create the annotation ID.          # Create the annotation ID.
2040          my $aid = "$fid:$timestamp";          my $aid = "$fid:$timestamp";
2041          # Insert the Annotation object.          # Insert the Annotation object.
# Line 1604  Line 2055 
2055    
2056  =head3 AssignFunction  =head3 AssignFunction
2057    
2058  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function); >>  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function, $assigningUser); >>
2059    
2060  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
2061  format is "XXXX\nset XXXX function to\nYYYYY" where XXXX is the feature type and YYYY is the functional  format is described in L</ParseAssignment>.
 assignment text.  
2062    
2063  =over 4  =over 4
2064    
# Line 1618  Line 2068 
2068    
2069  =item user  =item user
2070    
2071  Name of the user making the assignment. This is frequently a group name, like C<kegg> or C<fig>.  Name of the user group making the assignment, such as C<kegg> or C<fig>.
2072    
2073  =item function  =item function
2074    
2075  Text of the function being assigned.  Text of the function being assigned.
2076    
2077    =item assigningUser (optional)
2078    
2079    Name of the individual user making the assignment. If omitted, defaults to the user group.
2080    
2081  =item RETURN  =item RETURN
2082    
2083  Returns 1 if successful, 0 if an error occurred.  Returns 1 if successful, 0 if an error occurred.
# Line 1634  Line 2088 
2088  #: Return Type $;  #: Return Type $;
2089  sub AssignFunction {  sub AssignFunction {
2090          # Get the parameters.          # Get the parameters.
2091          my $self = shift @_;      my ($self, $featureID, $user, $function, $assigningUser) = @_;
2092          my ($featureID, $user, $function) = @_;      # Default the assigning user.
2093        if (! $assigningUser) {
2094            $assigningUser = $user;
2095        }
2096          # Create an annotation string from the parameters.          # Create an annotation string from the parameters.
2097          my $annotationText = "$user\nset $user function to\n$function";      my $annotationText = "$assigningUser\nset $user function to\n$function";
2098          # Get the current time.          # Get the current time.
2099          my $now = time;          my $now = time;
2100          # Declare the return variable.          # Declare the return variable.
# Line 1682  Line 2139 
2139  #: Return Type @;  #: Return Type @;
2140  sub FeaturesByAlias {  sub FeaturesByAlias {
2141          # Get the parameters.          # Get the parameters.
2142          my $self = shift @_;      my ($self, $alias) = @_;
         my ($alias) = @_;  
2143          # Declare the return variable.          # Declare the return variable.
2144          my @retVal = ();          my @retVal = ();
2145          # Parse the alias.          # Parse the alias.
# Line 1725  Line 2181 
2181  #: Return Type $;  #: Return Type $;
2182  sub Exists {  sub Exists {
2183          # Get the parameters.          # Get the parameters.
2184          my $self = shift @_;      my ($self, $entityName, $entityID) = @_;
         my ($entityName, $entityID) = @_;  
2185          # Check for the entity instance.          # Check for the entity instance.
2186        Trace("Checking existence of $entityName with ID=$entityID.") if T(4);
2187          my $testInstance = $self->GetEntity($entityName, $entityID);          my $testInstance = $self->GetEntity($entityName, $entityID);
2188          # Return an existence indicator.          # Return an existence indicator.
2189          my $retVal = ($testInstance ? 1 : 0);          my $retVal = ($testInstance ? 1 : 0);
# Line 1756  Line 2212 
2212  #: Return Type $;  #: Return Type $;
2213  sub FeatureTranslation {  sub FeatureTranslation {
2214          # Get the parameters.          # Get the parameters.
2215          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2216          # Get the specified feature's translation.          # Get the specified feature's translation.
2217          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);
2218          return $retVal;          return $retVal;
# Line 1789  Line 2244 
2244  #: Return Type @;  #: Return Type @;
2245  sub Taxonomy {  sub Taxonomy {
2246          # Get the parameters.          # Get the parameters.
2247          my $self = shift @_;      my ($self, $genome) = @_;
         my ($genome) = @_;  
2248          # Find the specified genome's taxonomy string.          # Find the specified genome's taxonomy string.
2249          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);
2250          # Declare the return variable.          # Declare the return variable.
# Line 1833  Line 2287 
2287  #: Return Type $;  #: Return Type $;
2288  sub CrudeDistance {  sub CrudeDistance {
2289          # Get the parameters.          # Get the parameters.
2290          my $self = shift @_;      my ($self, $genome1, $genome2) = @_;
         my ($genome1, $genome2) = @_;  
2291          # Insure that the distance is commutative by sorting the genome IDs.          # Insure that the distance is commutative by sorting the genome IDs.
2292          my ($genomeA, $genomeB);          my ($genomeA, $genomeB);
2293          if ($genome2 < $genome2) {          if ($genome2 < $genome2) {
# Line 1881  Line 2334 
2334  #: Return Type $;  #: Return Type $;
2335  sub RoleName {  sub RoleName {
2336          # Get the parameters.          # Get the parameters.
2337          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2338          # Get the specified role's name.          # Get the specified role's name.
2339          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);
2340          # Use the ID if the role has no name.          # Use the ID if the role has no name.
# Line 1915  Line 2367 
2367  #: Return Type @;  #: Return Type @;
2368  sub RoleDiagrams {  sub RoleDiagrams {
2369          # Get the parameters.          # Get the parameters.
2370          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2371          # Query for the diagrams.          # Query for the diagrams.
2372          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
2373                                                                  'RoleOccursIn(to-link)');                                                                  'RoleOccursIn(to-link)');
# Line 1924  Line 2375 
2375          return @retVal;          return @retVal;
2376  }  }
2377    
2378    =head3 GetProperties
2379    
2380    C<< my @list = $sprout->GetProperties($fid, $key, $value, $url); >>
2381    
2382    Return a list of the properties with the specified characteristics.
2383    
2384    Properties are arbitrary key-value pairs associated with a feature. (At some point they
2385    will also be associated with genomes.) A property value is represented by a 4-tuple of
2386    the form B<($fid, $key, $value, $url)>. These exactly correspond to the parameter
2387    
2388    =over 4
2389    
2390    =item fid
2391    
2392    ID of the feature possessing the property.
2393    
2394    =item key
2395    
2396    Name or key of the property.
2397    
2398    =item value
2399    
2400    Value of the property.
2401    
2402    =item url
2403    
2404    URL of the document that indicated the property should have this particular value, or an
2405    empty string if no such document exists.
2406    
2407    =back
2408    
2409    The parameters act as a filter for the desired data. Any non-null parameter will
2410    automatically match all the tuples returned. So, specifying just the I<$fid> will
2411    return all the properties of the specified feature; similarly, specifying the I<$key>
2412    and I<$value> parameters will return all the features having the specified property
2413    value.
2414    
2415    A single property key can have many values, representing different ideas about the
2416    feature in question. For example, one paper may declare that a feature C<fig|83333.1.peg.10> is
2417    virulent, and another may declare that it is not virulent. A query about the virulence of
2418    C<fig|83333.1.peg.10> would be coded as
2419    
2420        my @list = $sprout->GetProperties('fig|83333.1.peg.10', 'virulence', '', '');
2421    
2422    Here the I<$value> and I<$url> fields are left blank, indicating that those fields are
2423    not to be filtered. The tuples returned would be
2424    
2425        ('fig|83333.1.peg.10', 'virulence', 'yes', 'http://www.somewhere.edu/first.paper.pdf')
2426        ('fig|83333.1.peg.10', 'virulence', 'no', 'http://www.somewhere.edu/second.paper.pdf')
2427    
2428    =cut
2429    #: Return Type @@;
2430    sub GetProperties {
2431        # Get the parameters.
2432        my ($self, @parms) = @_;
2433        # Declare the return variable.
2434        my @retVal = ();
2435        # Now we need to create a WHERE clause that will get us the data we want. First,
2436        # we create a list of the columns containing the data for each parameter.
2437        my @colNames = ('HasProperty(from-link)', 'Property(property-name)',
2438                        'Property(property-value)', 'HasProperty(evidence)');
2439        # Now we build the WHERE clause and the list of parameter values.
2440        my @where = ();
2441        my @values = ();
2442        for (my $i = 0; $i <= $#colNames; $i++) {
2443            my $parm = $parms[$i];
2444            if (defined $parm && ($parm ne '')) {
2445                push @where, "$colNames[$i] = ?";
2446                push @values, $parm;
2447            }
2448        }
2449        # Format the WHERE clause.
2450        my $filter = (@values > 0 ? (join " AND ", @where) : undef);
2451        # Ask for all the propertie values with the desired characteristics.
2452        my $query = $self->Get(['HasProperty', 'Property'], $filter, \@values);
2453        while (my $valueObject = $query->Fetch()) {
2454            my @tuple = $valueObject->Values(\@colNames);
2455            push @retVal, \@tuple;
2456        }
2457        # Return the result.
2458        return @retVal;
2459    }
2460    
2461  =head3 FeatureProperties  =head3 FeatureProperties
2462    
2463  C<< my @properties = $sprout->FeatureProperties($featureID); >>  C<< my @properties = $sprout->FeatureProperties($featureID); >>
# Line 1953  Line 2487 
2487  #: Return Type @@;  #: Return Type @@;
2488  sub FeatureProperties {  sub FeatureProperties {
2489          # Get the parameters.          # Get the parameters.
2490          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2491          # Get the properties.          # Get the properties.
2492          my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],          my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],
2493                                                          ['Property(property-name)', 'Property(property-value)',                                                          ['Property(property-name)', 'Property(property-value)',
# Line 1985  Line 2518 
2518  #: Return Type $;  #: Return Type $;
2519  sub DiagramName {  sub DiagramName {
2520          # Get the parameters.          # Get the parameters.
2521          my $self = shift @_;      my ($self, $diagramID) = @_;
         my ($diagramID) = @_;  
2522          # Get the specified diagram's name and return it.          # Get the specified diagram's name and return it.
2523          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);
2524          return $retVal;          return $retVal;
# Line 2018  Line 2550 
2550  #: Return Type @;  #: Return Type @;
2551  sub MergedAnnotations {  sub MergedAnnotations {
2552          # Get the parameters.          # Get the parameters.
2553          my $self = shift @_;      my ($self, $list) = @_;
         my ($list) = @_;  
2554          # Create a list to hold the annotation tuples found.          # Create a list to hold the annotation tuples found.
2555          my @tuples = ();          my @tuples = ();
2556          # Loop through the features in the input list.          # Loop through the features in the input list.
# Line 2067  Line 2598 
2598  #: Return Type @;  #: Return Type @;
2599  sub RoleNeighbors {  sub RoleNeighbors {
2600          # Get the parameters.          # Get the parameters.
2601          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2602          # Get all the diagrams containing this role.          # Get all the diagrams containing this role.
2603          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
2604                                                                    'RoleOccursIn(to-link)');                                                                    'RoleOccursIn(to-link)');
# Line 2110  Line 2640 
2640  #: Return Type @;  #: Return Type @;
2641  sub FeatureLinks {  sub FeatureLinks {
2642          # Get the parameters.          # Get the parameters.
2643          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2644          # Get the feature's links.          # Get the feature's links.
2645          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);
2646          # Return the feature's links.          # Return the feature's links.
# Line 2123  Line 2652 
2652  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>
2653    
2654  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
2655  to the role the feature performs.  to the roles the feature performs.
2656    
2657  =over 4  =over 4
2658    
# Line 2133  Line 2662 
2662    
2663  =item RETURN  =item RETURN
2664    
2665  Returns a hash mapping all the feature's subsystems to the feature's role.  Returns a hash mapping all the feature's subsystems to a list of the feature's roles.
2666    
2667  =back  =back
2668    
2669  =cut  =cut
2670  #: Return Type %;  #: Return Type %@;
2671  sub SubsystemsOf {  sub SubsystemsOf {
2672          # Get the parameters.          # Get the parameters.
2673          my $self = shift @_;      my ($self, $featureID) = @_;
2674          my ($featureID) = @_;      # Get the subsystem list.
         # Use the SSCell to connect features to subsystems.  
2675          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],
2676                                                                          "ContainsFeature(to-link) = ?", [$featureID],                                                                          "ContainsFeature(to-link) = ?", [$featureID],
2677                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);
2678          # Create the return value.          # Create the return value.
2679          my %retVal = ();          my %retVal = ();
2680        # Build a hash to weed out duplicates. Sometimes the same PEG and role appears
2681        # in two spreadsheet cells.
2682        my %dupHash = ();
2683          # Loop through the results, adding them to the hash.          # Loop through the results, adding them to the hash.
2684          for my $record (@subsystems) {          for my $record (@subsystems) {
2685                  $retVal{$record->[0]} = $record->[1];          # Get this subsystem and role.
2686            my ($subsys, $role) = @{$record};
2687            # Insure it's the first time for both.
2688            my $dupKey = "$subsys\n$role";
2689            if (! exists $dupHash{"$subsys\n$role"}) {
2690                $dupHash{$dupKey} = 1;
2691                push @{$retVal{$subsys}}, $role;
2692            }
2693          }          }
2694          # Return the hash.          # Return the hash.
2695          return %retVal;          return %retVal;
2696  }  }
2697    
2698    =head3 SubsystemList
2699    
2700    C<< my @subsystems = $sprout->SubsystemList($featureID); >>
2701    
2702    Return a list containing the names of the subsystems in which the specified
2703    feature participates. Unlike L</SubsystemsOf>, this method only returns the
2704    subsystem names, not the roles.
2705    
2706    =over 4
2707    
2708    =item featureID
2709    
2710    ID of the feature whose subsystem names are desired.
2711    
2712    =item RETURN
2713    
2714    Returns a list of the names of the subsystems in which the feature participates.
2715    
2716    =back
2717    
2718    =cut
2719    #: Return Type @;
2720    sub SubsystemList {
2721        # Get the parameters.
2722        my ($self, $featureID) = @_;
2723        # Get the list of names.
2724        my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",
2725                                    [$featureID], 'HasSSCell(from-link)');
2726        # Return the result.
2727        return @retVal;
2728    }
2729    
2730  =head3 RelatedFeatures  =head3 RelatedFeatures
2731    
2732  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>
# Line 2190  Line 2760 
2760  #: Return Type @;  #: Return Type @;
2761  sub RelatedFeatures {  sub RelatedFeatures {
2762          # Get the parameters.          # Get the parameters.
2763          my $self = shift @_;      my ($self, $featureID, $function, $userID) = @_;
         my ($featureID, $function, $userID) = @_;  
2764          # 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.
2765          my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],          my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],
2766                                                                           "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],                                                                           "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],
# Line 2239  Line 2808 
2808  #: Return Type @;  #: Return Type @;
2809  sub TaxonomySort {  sub TaxonomySort {
2810          # Get the parameters.          # Get the parameters.
2811          my $self = shift @_;      my ($self, $featureIDs) = @_;
         my ($featureIDs) = @_;  
2812          # Create the working hash table.          # Create the working hash table.
2813          my %hashBuffer = ();          my %hashBuffer = ();
2814          # Loop through the features.          # Loop through the features.
# Line 2249  Line 2817 
2817                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",
2818                                                                                  [$fid], 'Genome(taxonomy)');                                                                                  [$fid], 'Genome(taxonomy)');
2819                  # Add this feature to the hash buffer.                  # Add this feature to the hash buffer.
2820                  if (exists $hashBuffer{$taxonomy}) {          Tracer::AddToListMap(\%hashBuffer, $taxonomy, $fid);
                         push @{$hashBuffer{$taxonomy}}, $fid;  
                 } else {  
                         $hashBuffer{$taxonomy} = [$fid];  
                 }  
2821          }          }
2822          # Sort the keys and get the elements.          # Sort the keys and get the elements.
2823          my @retVal = ();          my @retVal = ();
# Line 2322  Line 2886 
2886  #: Return Type @@;  #: Return Type @@;
2887  sub GetAll {  sub GetAll {
2888          # Get the parameters.          # Get the parameters.
2889          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList, $fields, $count) = @_;
2890          my ($objectNames, $filterClause, $parameterList, $fields, $count) = @_;      # Call the ERDB method.
2891          # Create the query.      my @retVal = $self->{_erdb}->GetAll($objectNames, $filterClause, $parameterList,
2892          my $query = $self->Get($objectNames, $filterClause, $parameterList);                                          $fields, $count);
         # Set up a counter of the number of records read.  
         my $fetched = 0;  
         # Insure the counter has a value.  
         if (!defined $count) {  
                 $count = 0;  
         }  
         # Loop through the records returned, extracting the fields. Note that if the  
         # counter is non-zero, we stop when the number of records read hits the count.  
         my @retVal = ();  
         while (($count == 0 || $fetched < $count) && (my $row = $query->Fetch())) {  
                 my @rowData = $row->Values($fields);  
                 push @retVal, \@rowData;  
                 $fetched++;  
         }  
2893          # Return the resulting list.          # Return the resulting list.
2894          return @retVal;          return @retVal;
2895  }  }
# Line 2384  Line 2934 
2934  #: Return Type @;  #: Return Type @;
2935  sub GetFlat {  sub GetFlat {
2936          # Get the parameters.          # Get the parameters.
2937          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList, $field) = @_;
         my ($objectNames, $filterClause, $parameterList, $field) = @_;  
2938          # Construct the query.          # Construct the query.
2939          my $query = $self->Get($objectNames, $filterClause, $parameterList);          my $query = $self->Get($objectNames, $filterClause, $parameterList);
2940          # Create the result list.          # Create the result list.
# Line 2495  Line 3044 
3044  #: Return Type @;  #: Return Type @;
3045  sub LoadInfo {  sub LoadInfo {
3046          # Get the parameters.          # Get the parameters.
3047          my $self = shift @_;      my ($self) = @_;
3048          # Create the return list, priming it with the name of the data directory.          # Create the return list, priming it with the name of the data directory.
3049          my @retVal = ($self->{_options}->{dataDir});          my @retVal = ($self->{_options}->{dataDir});
3050          # Concatenate the table names.          # Concatenate the table names.
# Line 2532  Line 3081 
3081  #: Return Type %;  #: Return Type %;
3082  sub LowBBHs {  sub LowBBHs {
3083          # Get the parsameters.          # Get the parsameters.
3084          my $self = shift @_;      my ($self, $featureID, $cutoff) = @_;
         my ($featureID, $cutoff) = @_;  
3085          # Create the return hash.          # Create the return hash.
3086          my %retVal = ();          my %retVal = ();
3087          # Create a query to get the desired BBHs.          # Create a query to get the desired BBHs.
# Line 2562  Line 3110 
3110  #: Return Type %@;  #: Return Type %@;
3111  sub GetGroups {  sub GetGroups {
3112      # Get the parameters.      # Get the parameters.
3113      my $self = shift @_;      my ($self, $groupList) = @_;
     my ($groupList) = @_;  
3114      # Declare the return value.      # Declare the return value.
3115      my %retVal = ();      my %retVal = ();
3116      # Determine whether we are getting all the groups or just some.      # Determine whether we are getting all the groups or just some.
# Line 2590  Line 3137 
3137              # Loop through the groups, adding the genome ID to each group's              # Loop through the groups, adding the genome ID to each group's
3138              # list.              # list.
3139              for my $group (@groups) {              for my $group (@groups) {
3140                  if (exists $retVal{$group}) {                  Tracer::AddToListMap(\%retVal, $group, $genomeID);
                     push @{$retVal{$group}}, $genomeID;  
                 } else {  
                     $retVal{$group} = [$genomeID];  
                 }  
3141              }              }
3142          }          }
3143      }      }
# Line 2602  Line 3145 
3145      return %retVal;      return %retVal;
3146  }  }
3147    
3148    =head3 MyGenomes
3149    
3150    C<< my @genomes = Sprout::MyGenomes($dataDir); >>
3151    
3152    Return a list of the genomes to be included in the Sprout.
3153    
3154    This method is provided for use during the Sprout load. It presumes the Genome load file has
3155    already been created. (It will be in the Sprout data directory and called either C<Genome>
3156    or C<Genome.dtx>.) Essentially, it reads in the Genome load file and strips out the genome
3157    IDs.
3158    
3159    =over 4
3160    
3161    =item dataDir
3162    
3163    Directory containing the Sprout load files.
3164    
3165    =back
3166    
3167    =cut
3168    #: Return Type @;
3169    sub MyGenomes {
3170        # Get the parameters.
3171        my ($dataDir) = @_;
3172        # Compute the genome file name.
3173        my $genomeFileName = LoadFileName($dataDir, "Genome");
3174        # Extract the genome IDs from the files.
3175        my @retVal = map { $_ =~ /^(\S+)/; $1 } Tracer::GetFile($genomeFileName);
3176        # Return the result.
3177        return @retVal;
3178    }
3179    
3180    =head3 LoadFileName
3181    
3182    C<< my $fileName = Sprout::LoadFileName($dataDir, $tableName); >>
3183    
3184    Return the name of the load file for the specified table in the specified data
3185    directory.
3186    
3187    =over 4
3188    
3189    =item dataDir
3190    
3191    Directory containing the Sprout load files.
3192    
3193    =item tableName
3194    
3195    Name of the table whose load file is desired.
3196    
3197    =item RETURN
3198    
3199    Returns the name of the file containing the load data for the specified table, or
3200    C<undef> if no load file is present.
3201    
3202    =back
3203    
3204    =cut
3205    #: Return Type $;
3206    sub LoadFileName {
3207        # Get the parameters.
3208        my ($dataDir, $tableName) = @_;
3209        # Declare the return variable.
3210        my $retVal;
3211        # Check for the various file names.
3212        if (-e "$dataDir/$tableName") {
3213            $retVal = "$dataDir/$tableName";
3214        } elsif (-e "$dataDir/$tableName.dtx") {
3215            $retVal = "$dataDir/$tableName.dtx";
3216        }
3217        # Return the result.
3218        return $retVal;
3219    }
3220    
3221  =head2 Internal Utility Methods  =head2 Internal Utility Methods
3222    
3223  =head3 ParseAssignment  =head3 ParseAssignment
3224    
3225  Parse annotation text to determine whether or not it is a functional assignment. If it is,  Parse annotation text to determine whether or not it is a functional assignment. If it is,
3226  the user and function text will be returned as a 2-element list. If it isn't, an empty list  the user, function text, and assigning user will be returned as a 3-element list. If it
3227  will be returned.  isn't, an empty list will be returned.
3228    
3229    A functional assignment is always of the form
3230    
3231        I<XXXX>C<\nset >I<YYYY>C< function to\n>I<ZZZZZ>
3232    
3233    where I<XXXX> is the B<assigning user>, I<YYYY> is the B<user>, and I<ZZZZ> is the
3234    actual functional role. In most cases, the user and the assigning user will be the
3235    same, but that is not always the case.
3236    
3237  This is a static method.  This is a static method.
3238    
# Line 2627  Line 3251 
3251    
3252  =cut  =cut
3253    
3254  sub ParseAssignment {  sub _ParseAssignment {
3255          # Get the parameters.          # Get the parameters.
3256          my ($text) = @_;          my ($text) = @_;
3257          # Declare the return value.          # Declare the return value.
3258          my @retVal = ();          my @retVal = ();
3259          # Check to see if this is a functional assignment.          # Check to see if this is a functional assignment.
3260          my ($user, $type, $function) = split(/\n/, $text);      my ($type, $function) = split(/\n/, $text);
3261          if ($type =~ m/^set $user function to$/i) {      if ($type =~ m/^set ([^ ]+) function to$/i) {
3262                  # Here it is, so we return the user name and function text.          # Here it is, so we return the user name (which is in $1), the functional role text,
3263                  @retVal = ($user, $function);          # and the assigning user.
3264            @retVal = ($1, $function);
3265          }          }
3266          # Return the result list.          # Return the result list.
3267          return @retVal;          return @retVal;
# Line 2664  Line 3289 
3289    
3290  sub FriendlyTimestamp {  sub FriendlyTimestamp {
3291      my ($timeValue) = @_;      my ($timeValue) = @_;
3292      my $retVal = strftime("%a %b %e %H:%M:%S %Y", localtime($timeValue));      my $retVal = localtime($timeValue);
3293      return $retVal;      return $retVal;
3294  }  }
3295    
3296    =head3 AddProperty
3297    
3298    C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>
3299    
3300    Add a new attribute value (Property) to a feature. In the SEED system, attributes can
3301    be added to almost any object. In Sprout, they can only be added to features. In
3302    Sprout, attributes are implemented using I<properties>. A property represents a key/value
3303    pair. If the particular key/value pair coming in is not already in the database, a new
3304    B<Property> record is created to hold it.
3305    
3306    =over 4
3307    
3308    =item peg
3309    
3310    ID of the feature to which the attribute is to be replied.
3311    
3312    =item key
3313    
3314    Name of the attribute (key).
3315    
3316    =item value
3317    
3318    Value of the attribute.
3319    
3320    =item url
3321    
3322    URL or text citation from which the property was obtained.
3323    
3324    =back
3325    
3326    =cut
3327    #: Return Type ;
3328    sub AddProperty {
3329        # Get the parameters.
3330        my ($self, $featureID, $key, $value, $url) = @_;
3331        # Declare the variable to hold the desired property ID.
3332        my $propID;
3333        # Attempt to find a property record for this key/value pair.
3334        my @properties = $self->GetFlat(['Property'],
3335                                       "Property(property-name) = ? AND Property(property-value) = ?",
3336                                       [$key, $value], 'Property(id)');
3337        if (@properties) {
3338            # Here the property is already in the database. We save its ID.
3339            $propID = $properties[0];
3340            # Here the property value does not exist. We need to generate an ID. It will be set
3341            # to a number one greater than the maximum value in the database. This call to
3342            # GetAll will stop after one record.
3343            my @maxProperty = $self->GetAll(['Property'], "ORDER BY Property(id) DESC", [], ['Property(id)'],
3344                                            1);
3345            $propID = $maxProperty[0]->[0] + 1;
3346            # Insert the new property value.
3347            $self->Insert('Property', { 'property-name' => $key, 'property-value' => $value, id => $propID });
3348        }
3349        # Now we connect the incoming feature to the property.
3350        $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });
3351    }
3352    
3353    
3354    
3355  1;  1;

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.45

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3