[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.18, Tue Jun 28 21:34:15 2005 UTC revision 1.21, Fri Sep 9 20:40:41 2005 UTC
# Line 576  Line 576 
576  =item RETURN  =item RETURN
577    
578  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
579  context and as a space-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context.
580    
581  =back  =back
582    
# Line 619  Line 619 
619          push @retVal, "${contigID}_$beg$dir$len";          push @retVal, "${contigID}_$beg$dir$len";
620      }      }
621      # Return the list in the format indicated by the context.      # Return the list in the format indicated by the context.
622      return (wantarray ? @retVal : join(' ', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
623  }  }
624    
625  =head3 ParseLocation  =head3 ParseLocation
# Line 1521  Line 1521 
1521          # Determine the ordering to place on the evidence items. If we're          # Determine the ordering to place on the evidence items. If we're
1522          # inverted, we want to see feature 2 before feature 1 (descending); otherwise,          # inverted, we want to see feature 2 before feature 1 (descending); otherwise,
1523          # we want feature 1 before feature 2 (normal).          # we want feature 1 before feature 2 (normal).
1524            Trace("Coupling evidence for ($peg1, $peg2) with inversion flag $inverted.") if T(Coupling => 4);
1525          my $ordering = ($inverted ? "DESC" : "");          my $ordering = ($inverted ? "DESC" : "");
1526          # Get the coupling evidence.          # Get the coupling evidence.
1527          my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],          my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],
# Line 1534  Line 1535 
1535          while (@evidenceList > 0) {          while (@evidenceList > 0) {
1536              my $peg1Data = shift @evidenceList;              my $peg1Data = shift @evidenceList;
1537              my $peg2Data = shift @evidenceList;              my $peg2Data = shift @evidenceList;
1538                Trace("Peg 1 is " . $peg1Data->[1] . " and Peg 2 is " . $peg2Data->[1] . ".") if T(Coupling => 4);
1539              push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];              push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];
1540          }          }
1541      }      }
# Line 2226  Line 2228 
2228      return @retVal;      return @retVal;
2229  }  }
2230    
2231    =head3 GetProperties
2232    
2233    C<< my @list = $sprout->GetProperties($fid, $key, $value, $url); >>
2234    
2235    Return a list of the properties with the specified characteristics.
2236    
2237    Properties are arbitrary key-value pairs associated with a feature. (At some point they
2238    will also be associated with genomes.) A property value is represented by a 4-tuple of
2239    the form B<($fid, $key, $value, $url)>. These exactly correspond to the parameter
2240    
2241    =over 4
2242    
2243    =item fid
2244    
2245    ID of the feature possessing the property.
2246    
2247    =item key
2248    
2249    Name or key of the property.
2250    
2251    =item value
2252    
2253    Value of the property.
2254    
2255    =item url
2256    
2257    URL of the document that indicated the property should have this particular value, or an
2258    empty string if no such document exists.
2259    
2260    =back
2261    
2262    The parameters act as a filter for the desired data. Any non-null parameter will
2263    automatically match all the tuples returned. So, specifying just the I<$fid> will
2264    return all the properties of the specified feature; similarly, specifying the I<$key>
2265    and I<$value> parameters will return all the features having the specified property
2266    value.
2267    
2268    A single property key can have many values, representing different ideas about the
2269    feature in question. For example, one paper may declare that a feature C<fig|83333.1.peg.10> is
2270    virulent, and another may declare that it is not virulent. A query about the virulence of
2271    C<fig|83333.1.peg.10> would be coded as
2272    
2273        my @list = $sprout->GetProperties('fig|83333.1.peg.10', 'virulence', '', '');
2274    
2275    Here the I<$value> and I<$url> fields are left blank, indicating that those fields are
2276    not to be filtered. The tuples returned would be
2277    
2278        ('fig|83333.1.peg.10', 'virulence', 'yes', 'http://www.somewhere.edu/first.paper.pdf')
2279        ('fig|83333.1.peg.10', 'virulence', 'no', 'http://www.somewhere.edu/second.paper.pdf')
2280    
2281    =cut
2282    #: Return Type @@;
2283    sub GetProperties {
2284        # Get the parameters.
2285        my ($self, @parms) = @_;
2286        # Declare the return variable.
2287        my @retVal = ();
2288        # Now we need to create a WHERE clause that will get us the data we want. First,
2289        # we create a list of the columns containing the data for each parameter.
2290        my @colNames = ('HasProperty(from-link)', 'Property(property-name)',
2291                        'Property(property-value)', 'HasProperty(evidence)');
2292        # Now we build the WHERE clause and the list of parameter values.
2293        my @where = ();
2294        my @values = ();
2295        for (my $i = 0; $i <= $#colNames; $i++) {
2296            my $parm = $parms[$i];
2297            if (defined $parm && ($parm ne '')) {
2298                push @where, "$colNames[$i] = ?";
2299                push @values, $parm;
2300            }
2301        }
2302        # Format the WHERE clause.
2303        my $filter = (@values > 0 ? (join " AND ", @where) : undef);
2304        # Ask for all the propertie values with the desired characteristics.
2305        my $query = $self->Get(['HasProperty', 'Property'], $filter, \@values);
2306        while (my $valueObject = $query->Fetch()) {
2307            my @tuple = $valueObject->Values(\@colNames);
2308            push @retVal, \@tuple;
2309        }
2310        # Return the result.
2311        return @retVal;
2312    }
2313    
2314  =head3 FeatureProperties  =head3 FeatureProperties
2315    
2316  C<< my @properties = $sprout->FeatureProperties($featureID); >>  C<< my @properties = $sprout->FeatureProperties($featureID); >>
# Line 2420  Line 2505 
2505  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>
2506    
2507  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
2508  to the role the feature performs.  to the roles the feature performs.
2509    
2510  =over 4  =over 4
2511    
# Line 2430  Line 2515 
2515    
2516  =item RETURN  =item RETURN
2517    
2518  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.
2519    
2520  =back  =back
2521    
2522  =cut  =cut
2523  #: Return Type %;  #: Return Type %@;
2524  sub SubsystemsOf {  sub SubsystemsOf {
2525      # Get the parameters.      # Get the parameters.
2526      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
# Line 2447  Line 2532 
2532      my %retVal = ();      my %retVal = ();
2533      # Loop through the results, adding them to the hash.      # Loop through the results, adding them to the hash.
2534      for my $record (@subsystems) {      for my $record (@subsystems) {
2535          $retVal{$record->[0]} = $record->[1];          my ($subsys, $role) = @{$record};
2536            if (exists $retVal{$subsys}) {
2537                push @{$retVal{$subsys}}, $role;
2538            } else {
2539                $retVal{$subsys} = [$role];
2540            }
2541      }      }
2542      # Return the hash.      # Return the hash.
2543      return %retVal;      return %retVal;
# Line 3108  Line 3198 
3198      $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });      $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });
3199  }  }
3200    
3201    
3202    
3203  1;  1;

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.21

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3