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

Diff of /Sprout/SimBlocks.pm

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

revision 1.10, Tue Apr 10 06:12:29 2007 UTC revision 1.11, Thu Dec 6 14:58:03 2007 UTC
# Line 174  Line 174 
174    
175  =head3 new  =head3 new
176    
177  C<< my $simdb = SimBlocks->new($dbname, $dbType, $port); >>      my $simdb = SimBlocks->new($dbname, $dbType, $port);
178    
179  Construct a new SimBlocks object connected to the specified database. If no  Construct a new SimBlocks object connected to the specified database. If no
180  database is specified, the default database indicated by C<FIG_Config::simBlocksDB>  database is specified, the default database indicated by C<FIG_Config::simBlocksDB>
# Line 185  Line 185 
185    
186  In almost every case, you will be calling  In almost every case, you will be calling
187    
188  C<< my $simdb = SimBlocks->new(); >>      my $simdb = SimBlocks->new();
189    
190  =over 4  =over 4
191    
# Line 233  Line 233 
233    
234  =head3 DBName  =head3 DBName
235    
236  C<< my $name = SimBlocks::DBName; >>      my $name = SimBlocks::DBName;
237    
238  Return the name of the database. This is set from a config variable, but if the  Return the name of the database. This is set from a config variable, but if the
239  variable is undefined a default value is used.  variable is undefined a default value is used.
# Line 252  Line 252 
252    
253  =head3 DefaultDistances  =head3 DefaultDistances
254    
255  C<< my $distances = DefaultDistances(); >>      my $distances = DefaultDistances();
256    
257  Return the default distance matrix for computing the alignment distances (see  Return the default distance matrix for computing the alignment distances (see
258  also L</DistanceMatrix>. This matrix returns a distance of 0 between an insertion  also L</DistanceMatrix>. This matrix returns a distance of 0 between an insertion
# Line 284  Line 284 
284    
285  =head3 DBLoad  =head3 DBLoad
286    
287  C<< my $stats = $simBlocks->DBLoad($rebuild); >>      my $stats = $simBlocks->DBLoad($rebuild);
288    
289  Load the database from the default directory. This is essentially identical to  Load the database from the default directory. This is essentially identical to
290  a B<LoadTables> call with the default directory used instead of a caller-specified  a B<LoadTables> call with the default directory used instead of a caller-specified
# Line 319  Line 319 
319    
320  =head3 CompareGenomes  =head3 CompareGenomes
321    
322  C<< my (\%set0Blocks, \%set1Blocks, \%bothBlocks) = $simBlocks->CompareGenomes(\@set0, \@set1); >>      my (\%set0Blocks, \%set1Blocks, \%bothBlocks) = $simBlocks->CompareGenomes(\@set0, \@set1);
323    
324  Analyze two sets of genomes for commonalities. The group blocks returned will be divided  Analyze two sets of genomes for commonalities. The group blocks returned will be divided
325  into three hashes: one for those common to set 0 and not occurring at all in set 1, one  into three hashes: one for those common to set 0 and not occurring at all in set 1, one
# Line 401  Line 401 
401    
402  =head3 RemoveBlocks  =head3 RemoveBlocks
403    
404  C<< $simBlocks->RemoveBlocks(\%blockMap, \@set); >>      $simBlocks->RemoveBlocks(\%blockMap, \@set);
405    
406  Remove from the specified block map any blocks that occur in the specified set of genomes.  Remove from the specified block map any blocks that occur in the specified set of genomes.
407  The block map can contain any data, but it must be keyed by block ID.  The block map can contain any data, but it must be keyed by block ID.
# Line 440  Line 440 
440    
441  =head3 BlocksInSet  =head3 BlocksInSet
442    
443  C<< my %blockList = $simBlocks->BlocksInSet($set, $count); >>      my %blockList = $simBlocks->BlocksInSet($set, $count);
444    
445  Return a list of the group blocks found in a given number of the genomes in a given  Return a list of the group blocks found in a given number of the genomes in a given
446  set. The list returned will be a hash of B<ERDBObject>s, each corresponding to a single  set. The list returned will be a hash of B<ERDBObject>s, each corresponding to a single
# Line 518  Line 518 
518    
519  =head3 GetRegions  =head3 GetRegions
520    
521  C<< my %regions = $simBlocks->GetRegions($blockID, \@genomes); >>      my %regions = $simBlocks->GetRegions($blockID, \@genomes);
522    
523  Return the regions of the specified block that occur in the contigs of  Return the regions of the specified block that occur in the contigs of
524  the specified genomes. The return value is a hash of DNA strings keyed  the specified genomes. The return value is a hash of DNA strings keyed
# Line 574  Line 574 
574    
575  =head3 SetNumber  =head3 SetNumber
576    
577  C<< my $setNumber = SimBlocks::SetNumber($contigRegion, \@set0, \@set1, ..., \@setN); >>      my $setNumber = SimBlocks::SetNumber($contigRegion, \@set0, \@set1, ..., \@setN);
578    
579  Examine a region string, contig ID, or genome ID, and return the number of the genome  Examine a region string, contig ID, or genome ID, and return the number of the genome
580  set to which it belongs.  set to which it belongs.
# Line 620  Line 620 
620    
621  =head3 TagDNA  =head3 TagDNA
622    
623  C<< my $taggedDNA = SimBlocks::TagDNA($pattern, $dnaString, $prefix, $suffix); >>      my $taggedDNA = SimBlocks::TagDNA($pattern, $dnaString, $prefix, $suffix);
624    
625  Convert a DNA string from the B<Region> relation to the actual DNA.  Convert a DNA string from the B<Region> relation to the actual DNA.
626  The incoming DNA string will contain only the values corresponding to the  The incoming DNA string will contain only the values corresponding to the
# Line 695  Line 695 
695    
696  =head3 SnipScan  =head3 SnipScan
697    
698  C<< my %positions = $simBlocks->SnipScan($blockObject, \@set0, \@set1); >>      my %positions = $simBlocks->SnipScan($blockObject, \@set0, \@set1);
699    
700  Examine the specified block and return a list of the positions at which the  Examine the specified block and return a list of the positions at which the
701  nucleotide values for regions in the first genome set differ from the values  nucleotide values for regions in the first genome set differ from the values
# Line 807  Line 807 
807    
808  =head3 ParsePattern  =head3 ParsePattern
809    
810  C<< my @positions = SimBlocks::ParsePattern($pattern); >>      my @positions = SimBlocks::ParsePattern($pattern);
811    
812  Get a list of the positions of variance inside a block pattern. The  Get a list of the positions of variance inside a block pattern. The
813  positions of variance are marked by question marks, so all we need to  positions of variance are marked by question marks, so all we need to
# Line 846  Line 846 
846    
847  =head3 MergeDNA  =head3 MergeDNA
848    
849  C<< my ($groupSequence, $variance) = SimBlocks::MergeDNA($groupSequence, $newSequence); >>      my ($groupSequence, $variance) = SimBlocks::MergeDNA($groupSequence, $newSequence);
850    
851  Merge the DNA for a region into the group representation of similar DNA, returning the  Merge the DNA for a region into the group representation of similar DNA, returning the
852  result and the positions of variance. Positions of variance in the group representation  result and the positions of variance. Positions of variance in the group representation
# Line 909  Line 909 
909    
910  =head3 GetAlignment  =head3 GetAlignment
911    
912  C<< my %sequences = $$simBlocks->GetAlignment(\@blockIDs, \@genomeIDs, $indels); >>      my %sequences = $$simBlocks->GetAlignment(\@blockIDs, \@genomeIDs, $indels);
913    
914  Return an alignment of the specified genomes relative to the specified block  Return an alignment of the specified genomes relative to the specified block
915  IDs. Only blocks in which all of the genomes occur will produce output for  IDs. Only blocks in which all of the genomes occur will produce output for
# Line 1006  Line 1006 
1006    
1007  =head3 DistanceMatrix  =head3 DistanceMatrix
1008    
1009  C<< my %distances = SimBlocks::DistanceMatrix(\%sequences, \%distances); >>      my %distances = SimBlocks::DistanceMatrix(\%sequences, \%distances);
1010    
1011  Compute the distances between the sequences in an alignment. the L</SequenceDistance>  Compute the distances between the sequences in an alignment. the L</SequenceDistance>
1012  method is used to compute the individual distances.  method is used to compute the individual distances.
# Line 1066  Line 1066 
1066    
1067  =head3 SequenceDistance  =head3 SequenceDistance
1068    
1069  C<< my $dist = SimBlocks::SequenceDistance($seq1, $seq2, $distances); >>      my $dist = SimBlocks::SequenceDistance($seq1, $seq2, $distances);
1070    
1071  Return the distance between two sequences. The distance presumes that  Return the distance between two sequences. The distance presumes that
1072  each alignment is a vector of sorts, with purines (C<A>/C<T>) and pyrmidines (C<G>/C<C>)  each alignment is a vector of sorts, with purines (C<A>/C<T>) and pyrmidines (C<G>/C<C>)
# Line 1128  Line 1128 
1128    
1129  =head3 GetBlock  =head3 GetBlock
1130    
1131  C<< my $blockData = $simBlocks->GetBlock($blockID); >>      my $blockData = $simBlocks->GetBlock($blockID);
1132    
1133  Return a B<ERDBObject> for a specified group block.  Return a B<ERDBObject> for a specified group block.
1134    
# Line 1158  Line 1158 
1158    
1159  =head3 GetBlockPieces  =head3 GetBlockPieces
1160    
1161  C<< my @blocks = $blockData->GetBlockPieces($location); >>      my @blocks = $blockData->GetBlockPieces($location);
1162    
1163  Return a map of the block pieces inside the specified location. The return  Return a map of the block pieces inside the specified location. The return
1164  value will be a list of block locations. A block location is essentially a  value will be a list of block locations. A block location is essentially a
# Line 1265  Line 1265 
1265    
1266  =head3 GetFeatureBlockPieces  =head3 GetFeatureBlockPieces
1267    
1268  C<< my @pieces = $simBlocks->GetFeatureBlockPieces($fig, \@featureIDs, $distance); >>      my @pieces = $simBlocks->GetFeatureBlockPieces($fig, \@featureIDs, $distance);
1269    
1270  Return a list of the block pieces within the specified distance of the  Return a list of the block pieces within the specified distance of the
1271  specified features. This method essentially computes locations from  specified features. This method essentially computes locations from
# Line 1370  Line 1370 
1370    
1371  =head3 WalkDNA  =head3 WalkDNA
1372    
1373  C<< my $blockPos = SimBlocks::WalkDNA($blockPos, $contigPos, $dna, $loc); >>      my $blockPos = SimBlocks::WalkDNA($blockPos, $contigPos, $dna, $loc);
1374    
1375  Location the desired position within a block of a specified location in a contig.  Location the desired position within a block of a specified location in a contig.
1376    

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.11

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3