[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.80, Thu Aug 10 07:34:37 2006 UTC revision 1.89, Wed Sep 27 16:55:38 2006 UTC
# Line 131  Line 131 
131      # Add the option table and XML file name.      # Add the option table and XML file name.
132      $retVal->{_options} = $optionTable;      $retVal->{_options} = $optionTable;
133      $retVal->{_xmlName} = $xmlFileName;      $retVal->{_xmlName} = $xmlFileName;
134        # Set up space for the group file data.
135        $retVal->{groupHash} = undef;
136      # Return it.      # Return it.
137      return $retVal;      return $retVal;
138  }  }
# Line 340  Line 342 
342    
343  =head3 GeneMenu  =head3 GeneMenu
344    
345  C<< my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params); >>  C<< my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params, $selected); >>
346    
347  Return an HTML select menu of genomes. Each genome will be an option in the menu,  Return an HTML select menu of genomes. Each genome will be an option in the menu,
348  and will be displayed by name with the ID and a contig count attached. The selection  and will be displayed by name with the ID and a contig count attached. The selection
# Line 362  Line 364 
364  Reference to a list of values to be substituted in for the parameter marks in  Reference to a list of values to be substituted in for the parameter marks in
365  the filter string.  the filter string.
366    
367    =item selected (optional)
368    
369    ID of the genome to be initially selected.
370    
371    =item fast (optional)
372    
373    If specified and TRUE, the contig counts will be omitted to improve performance.
374    
375  =item RETURN  =item RETURN
376    
377  Returns an HTML select menu with the specified genomes as selectable options.  Returns an HTML select menu with the specified genomes as selectable options.
# Line 372  Line 382 
382    
383  sub GeneMenu {  sub GeneMenu {
384      # Get the parameters.      # Get the parameters.
385      my ($self, $attributes, $filterString, $params) = @_;      my ($self, $attributes, $filterString, $params, $selected, $fast) = @_;
386        my $slowMode = ! $fast;
387        # Default to nothing selected. This prevents an execution warning if "$selected"
388        # is undefined.
389        $selected = "" unless defined $selected;
390        Trace("Gene Menu called with slow mode \"$slowMode\" and selection \"$selected\".") if T(3);
391      # Start the menu.      # Start the menu.
392      my $retVal = "<select " .      my $retVal = "<select " .
393          join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .          join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .
# Line 389  Line 404 
404          # Get the data for this genome.          # Get the data for this genome.
405          my ($genomeID, $genus, $species, $strain) = @{$genomeData};          my ($genomeID, $genus, $species, $strain) = @{$genomeData};
406          # Get the contig count.          # Get the contig count.
407            my $contigInfo = "";
408            if ($slowMode) {
409          my $count = $self->ContigCount($genomeID);          my $count = $self->ContigCount($genomeID);
410          my $counting = ($count == 1 ? "contig" : "contigs");          my $counting = ($count == 1 ? "contig" : "contigs");
411                $contigInfo = "[$count $counting]";
412            }
413            # Find out if we're selected.
414            my $selectOption = ($selected eq $genomeID ? " selected" : "");
415          # Build the option tag.          # Build the option tag.
416          $retVal .= "<option value=\"$genomeID\">$genus $species $strain ($genomeID) [$count $counting]</option>\n";          $retVal .= "<option value=\"$genomeID\"$selectOption>$genus $species $strain ($genomeID)$contigInfo</option>\n";
         Trace("Option tag built for $genomeID: $genus $species $strain.") if T(3);  
417      }      }
418      # Close the SELECT tag.      # Close the SELECT tag.
419      $retVal .= "</select>\n";      $retVal .= "</select>\n";
420      # Return the result.      # Return the result.
421      return $retVal;      return $retVal;
422  }  }
423    
424  =head3 Build  =head3 Build
425    
426  C<< $sprout->Build(); >>  C<< $sprout->Build(); >>
# Line 634  Line 655 
655      return ($contigID, $start, $dir, $len);      return ($contigID, $start, $dir, $len);
656  }  }
657    
658    
659    
660  =head3 PointLocation  =head3 PointLocation
661    
662  C<< my $found = Sprout::PointLocation($location, $point); >>  C<< my $found = Sprout::PointLocation($location, $point); >>
# Line 1476  Line 1499 
1499      my %retVal = ();      my %retVal = ();
1500      # Loop through the incoming features.      # Loop through the incoming features.
1501      for my $featureID (@{$featureList}) {      for my $featureID (@{$featureList}) {
1502          # Create a query to get the feature's best hit.          # Ask the server for the feature's best hit.
1503          my $query = $self->Get(['IsBidirectionalBestHitOf'],          my @bbhData = FIGRules::BBHData($featureID);
                                "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",  
                                [$featureID, $genomeID]);  
1504          # Peel off the BBHs found.          # Peel off the BBHs found.
1505          my @found = ();          my @found = ();
1506          while (my $bbh = $query->Fetch) {          for my $bbh (@bbhData) {
1507              push @found, $bbh->Value('IsBidirectionalBestHitOf(to-link)');              push @found, $bbh->[0];
1508          }          }
1509          $retVal{$featureID} = \@found;          $retVal{$featureID} = \@found;
1510      }      }
# Line 1497  Line 1518 
1518    
1519  Return a list of the similarities to the specified feature.  Return a list of the similarities to the specified feature.
1520    
1521  Sprout does not support real similarities, so this method just returns the bidirectional  This method just returns the bidirectional best hits for performance reasons.
 best hits.  
1522    
1523  =over 4  =over 4
1524    
# Line 1518  Line 1538 
1538      # Get the parameters.      # Get the parameters.
1539      my ($self, $featureID, $count) = @_;      my ($self, $featureID, $count) = @_;
1540      # Ask for the best hits.      # Ask for the best hits.
1541      my @lists = $self->GetAll(['IsBidirectionalBestHitOf'],      my @lists = FIGRules::BBHData($featureID);
                               "IsBidirectionalBestHitOf(from-link) = ? ORDER BY IsBidirectionalBestHitOf(score) DESC",  
                               [$featureID], ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(score)'],  
                               $count);  
1542      # Create the return value.      # Create the return value.
1543      my %retVal = ();      my %retVal = ();
1544      for my $tuple (@lists) {      for my $tuple (@lists) {
# Line 1531  Line 1548 
1548      return %retVal;      return %retVal;
1549  }  }
1550    
   
   
1551  =head3 IsComplete  =head3 IsComplete
1552    
1553  C<< my $flag = $sprout->IsComplete($genomeID); >>  C<< my $flag = $sprout->IsComplete($genomeID); >>
# Line 2664  Line 2679 
2679      return $retVal;      return $retVal;
2680  }  }
2681    
2682    =head3 PropertyID
2683    
2684    C<< my $id = $sprout->PropertyID($propName, $propValue); >>
2685    
2686    Return the ID of the specified property name and value pair, if the
2687    pair exists.
2688    
2689    =over 4
2690    
2691    =item propName
2692    
2693    Name of the desired property.
2694    
2695    =item propValue
2696    
2697    Value expected for the desired property.
2698    
2699    =item RETURN
2700    
2701    Returns the ID of the name/value pair, or C<undef> if the pair does not exist.
2702    
2703    =back
2704    
2705    =cut
2706    
2707    sub PropertyID {
2708        # Get the parameters.
2709        my ($self, $propName, $propValue) = @_;
2710        # Try to find the ID.
2711        my ($retVal) = $self->GetFlat(['Property'],
2712                                      "Property(property-name) = ? AND Property(property-value) = ?",
2713                                      [$propName, $propValue], 'Property(id)');
2714        # Return the result.
2715        return $retVal;
2716    }
2717    
2718  =head3 MergedAnnotations  =head3 MergedAnnotations
2719    
2720  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>
# Line 2861  Line 2912 
2912      # Get the parameters.      # Get the parameters.
2913      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2914      # Get the list of names.      # Get the list of names.
2915      my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",      my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",
2916                                  [$featureID], 'HasSSCell(from-link)');                                  [$featureID], 'HasRoleInSubsystem(to-link)');
2917      # Return the result.      # Return the result, sorted.
2918      return @retVal;      return sort @retVal;
2919  }  }
2920    
2921  =head3 GenomeSubsystemData  =head3 GenomeSubsystemData
# Line 2962  Line 3013 
3013      # Get the parameters.      # Get the parameters.
3014      my ($self, $featureID, $function, $userID) = @_;      my ($self, $featureID, $function, $userID) = @_;
3015      # Get a list of the features that are BBHs of the incoming feature.      # Get a list of the features that are BBHs of the incoming feature.
3016      my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],      my @bbhFeatures = map { $_->[0] } FIGRules::BBHData($featureID);
                                      "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],  
                                      'IsBidirectionalBestHitOf(to-link)');  
3017      # Now we loop through the features, pulling out the ones that have the correct      # Now we loop through the features, pulling out the ones that have the correct
3018      # functional assignment.      # functional assignment.
3019      my @retVal = ();      my @retVal = ();
# Line 3165  Line 3214 
3214      my ($self, $featureID, $cutoff) = @_;      my ($self, $featureID, $cutoff) = @_;
3215      # Create the return hash.      # Create the return hash.
3216      my %retVal = ();      my %retVal = ();
3217      # Create a query to get the desired BBHs.      # Query for the desired BBHs.
3218      my @bbhList = $self->GetAll(['IsBidirectionalBestHitOf'],      my @bbhList = FIGRules::BBHData($featureID, $cutoff);
                                 'IsBidirectionalBestHitOf(sc) <= ? AND IsBidirectionalBestHitOf(from-link) = ?',  
                                 [$cutoff, $featureID],  
                                 ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(sc)']);  
3219      # Form the results into the return hash.      # Form the results into the return hash.
3220      for my $pair (@bbhList) {      for my $pair (@bbhList) {
3221          $retVal{$pair->[0]} = $pair->[1];          $retVal{$pair->[0]} = $pair->[1];
# Line 3264  Line 3310 
3310          # Here we have a group list. Loop through them individually,          # Here we have a group list. Loop through them individually,
3311          # getting a list of the relevant genomes.          # getting a list of the relevant genomes.
3312          for my $group (@{$groupList}) {          for my $group (@{$groupList}) {
3313              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(group-name) = ?",              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(primary-group) = ?",
3314                  [$group], "Genome(id)");                  [$group], "Genome(id)");
3315              $retVal{$group} = \@genomeIDs;              $retVal{$group} = \@genomeIDs;
3316          }          }
# Line 3272  Line 3318 
3318          # Here we need all of the groups. In this case, we run through all          # Here we need all of the groups. In this case, we run through all
3319          # of the genome records, putting each one found into the appropriate          # of the genome records, putting each one found into the appropriate
3320          # group. Note that we use a filter clause to insure that only genomes          # group. Note that we use a filter clause to insure that only genomes
3321          # in groups are included in the return set.          # in real NMPDR groups are included in the return set.
3322          my @genomes = $self->GetAll(['Genome'], "Genome(group-name) > ' '", [],          my @genomes = $self->GetAll(['Genome'], "Genome(primary-group) <> ?",
3323                                      ['Genome(id)', 'Genome(group-name)']);                                      [$FIG_Config::otherGroup], ['Genome(id)', 'Genome(primary-group)']);
3324          # Loop through the genomes found.          # Loop through the genomes found.
3325          for my $genome (@genomes) {          for my $genome (@genomes) {
3326              # Pop this genome's ID off the current list.              # Pop this genome's ID off the current list.
# Line 3400  Line 3446 
3446      return $retVal;      return $retVal;
3447  }  }
3448    
3449    =head3 Fix
3450    
3451    C<< my %fixedHash = Sprout::Fix(%groupHash); >>
3452    
3453    Prepare a genome group hash (like that returned by L</GetGroups> for processing.
3454    Groups with the same primary name will be combined. The primary name is the
3455    first capitalized word in the group name.
3456    
3457    =over 4
3458    
3459    =item groupHash
3460    
3461    Hash to be fixed up.
3462    
3463    =item RETURN
3464    
3465    Returns a fixed-up version of the hash.
3466    
3467    =back
3468    
3469    =cut
3470    
3471    sub Fix {
3472        # Get the parameters.
3473        my (%groupHash) = @_;
3474        # Create the result hash.
3475        my %retVal = ();
3476        # Copy over the genomes.
3477        for my $groupID (keys %groupHash) {
3478            # Make a safety copy of the group ID.
3479            my $realGroupID = $groupID;
3480            # Yank the primary name.
3481            if ($groupID =~ /([A-Z]\w+)/) {
3482                $realGroupID = $1;
3483            }
3484            # Append this group's genomes into the result hash.
3485            Tracer::AddToListMap(\%retVal, $realGroupID, @{$groupHash{$groupID}});
3486        }
3487        # Return the result hash.
3488        return %retVal;
3489    }
3490    
3491    =head3 GroupPageName
3492    
3493    C<< my $name = $sprout->GroupPageName($group); >>
3494    
3495    Return the name of the page for the specified NMPDR group.
3496    
3497    =over 4
3498    
3499    =item group
3500    
3501    Name of the relevant group.
3502    
3503    =item RETURN
3504    
3505    Returns the relative page name (e.g. C<../content/campy.php>). If the group file is not in
3506    memory it will be read in.
3507    
3508    =back
3509    
3510    =cut
3511    
3512    sub GroupPageName {
3513        # Get the parameters.
3514        my ($self, $group) = @_;
3515        # Declare the return variable.
3516        my $retVal;
3517        # Check for the group file data.
3518        if (! defined $self->{groupHash}) {
3519            # Read the group file.
3520            my %groupData = Sprout::ReadGroupFile($self->{_options}->{dataDir} . "/groups.tbl");
3521            # Store it in our object.
3522            $self->{groupHash} = \%groupData;
3523        }
3524        # Compute the real group name.
3525        my $realGroup = $group;
3526        if ($group =~ /([A-Z]\w+)/) {
3527            $realGroup = $1;
3528        }
3529        # Return the page name.
3530        $retVal = "../content/" . $self->{groupHash}->{$realGroup}->[1];
3531        # Return the result.
3532        return $retVal;
3533    }
3534    
3535    =head3 ReadGroupFile
3536    
3537    C<< my %groupData = Sprout::ReadGroupFile($groupFileName); >>
3538    
3539    Read in the data from the specified group file. The group file contains information
3540    about each of the NMPDR groups.
3541    
3542    =over 4
3543    
3544    =item name
3545    
3546    Name of the group.
3547    
3548    =item page
3549    
3550    Name of the group's page on the web site (e.g. C<campy.php> for
3551    Campylobacter)
3552    
3553    =item genus
3554    
3555    Genus of the group
3556    
3557    =item species
3558    
3559    Species of the group, or an empty string if the group is for an entire
3560    genus. If the group contains more than one species, the species names
3561    should be separated by commas.
3562    
3563    =back
3564    
3565    The parameters to this method are as follows
3566    
3567    =over 4
3568    
3569    =item groupFile
3570    
3571    Name of the file containing the group data.
3572    
3573    =item RETURN
3574    
3575    Returns a hash keyed on group name. The value of each hash
3576    
3577    =back
3578    
3579    =cut
3580    
3581    sub ReadGroupFile {
3582        # Get the parameters.
3583        my ($groupFileName) = @_;
3584        # Declare the return variable.
3585        my %retVal;
3586        # Read the group file.
3587        my @groupLines = Tracer::GetFile($groupFileName);
3588        for my $groupLine (@groupLines) {
3589            my ($name, $page, $genus, $species) = split(/\t/, $groupLine);
3590            $retVal{$name} = [$page, $genus, $species];
3591        }
3592        # Return the result.
3593        return %retVal;
3594    }
3595    
3596  =head2 Internal Utility Methods  =head2 Internal Utility Methods
3597    
3598  =head3 ParseAssignment  =head3 ParseAssignment
# Line 3456  Line 3649 
3649      }      }
3650      # If we have an assignment, we need to clean the function text. There may be      # If we have an assignment, we need to clean the function text. There may be
3651      # extra junk at the end added as a note from the user.      # extra junk at the end added as a note from the user.
3652      if (@retVal > 1) {      if (defined( $retVal[1] )) {
3653          $retVal[1] =~ s/(\t\S)?\s*$//;          $retVal[1] =~ s/(\t\S)?\s*$//;
3654      }      }
3655      # Return the result list.      # Return the result list.

Legend:
Removed from v.1.80  
changed lines
  Added in v.1.89

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3