Class RestrictionEnzyme

Description

RestrictionEnzyme.php

Class for restriction enzymes

Located in /Restriction/RestrictionEnzyme.php (line 43)

PEAR
   |
   --Bio
      |
      --RestrictionEnzyme
Method Summary
RestrictionEnzyme __construct ( $aEnzymeProperties)
void compatibleEnds ()
void cutter ()
void getCut ()
void getIsPrototype ()
void getMicrobe ()
void getName ()
void getReferences ()
void getRevCompSite ()
void getSeq ()
string getSite ()
void getSource ()
void getVendors ()
void isUnAmbiguous ()
void overhang ()
void overhangSeq ()
void purgeReferences ()
void purgeVendors ()
void setCut ( $iCut)
void setIsoschizomers ( $aIsoschizomers)
void setIsPallindromic ( $bIsPallindromic)
void setIsPrototype ( $bIsPrototype)
void setMethylationSites ( $aMethylationSites)
void setMicrobe ( $sMicrobe)
: setName (string $sName)
void setPrototypeName ( $sPrototypeName)
void setReferences ( $aReferences)
Integer setRevCompCut ($iCut $iCut)
void setRevCompSite ()
void setSeq (Dna $oSeq)
string setSite (string $sSite)
void setSource ( $sSource)
void setVendors ( $aVendors)
void string ()
void type ()
void __call (string $sMethod, array $aArguments)
Variables

Inherited Variables

Inherited from Bio

Bio::$bWarnings
Methods
Constructor __construct (line 167)

function __construct Is the constructor method for the Restriction class. It creates a new RestrictionEnzyme object and initializes its properties accordingly.

If passed with make = 'custom', object will be added to Restriction_DB. If not, the function will attempt to retrieve data from Restriction_DB. If unsuccessful in retrieving data, it will return an error flag.

RestrictionEnzyme __construct ( $aEnzymeProperties)
  • $aEnzymeProperties

Redefinition of:
Bio::__construct()
function Bio ()
compatibleEnds (line 953)

compatibleEnds

void compatibleEnds ()
cutter (line 792)

cutter

void cutter ()
getCut (line 623)

getCut

void getCut ()
getIsoschizomers (line 1184)

getIsoschizomers

void getIsoschizomers ()
getIsPallindromic (line 1013)

getIsPallindromic

void getIsPallindromic ()
getIsPrototype (line 1069)

getIsPrototype

void getIsPrototype ()
getMethylationSites (line 1272)

getMethylationSites

void getMethylationSites ()
getMicrobe (line 1352)

getMicrobe

void getMicrobe ()
getName (line 274)

getName

void getName ()
getPrototypeName (line 1125)

getPrototypeName

void getPrototypeName ()
getReferences (line 1511)

getReferences

void getReferences ()
getRevCompSite (line 416)

getRevCompSite

void getRevCompSite ()
getSeq (line 290)

getSeq Gets the sequence object for the enzyme.

  1. $re->getSeq();

void getSeq ()
getSite (line 339)

site Gets the recognition sequence for the enzyme.

Side effect: the sequence is always converted to upper case. The cut site can also be set by using methods L<cut|cut> and L<complementary_cut|complementary_cut>. This will pad out missing sequence with N's. For example the enzyme Acc36I cuts at ACCTGC(4/8). This will be returned as ACCTGCNNNN^ Note that the common notation ACCTGC(4/8) means that the forward strand cut is four nucleotides after the END of the recognition site. The forward cut() in the coordinates used here in Acc36I ACCTGC(4/8) is at 6+4 i.e. 10. This is the main setable method for the recognition site.

  1. $sRecogSeq $re->getSite();

  • return: string containing recognition sequence indicating cleavage site as in 'G^AATTC'.
string getSite ()
getSource (line 1398)

getSource

void getSource ()
getVendors (line 1490)

getVendors

void getVendors ()
isUnAmbiguous (line 986)

isAmbiguous

void isUnAmbiguous ()
overhang (line 833)

overhang

void overhang ()
overhangSeq (line 889)

overhangSeq

void overhangSeq ()
purgeIsoschizomers (line 1230)

purgeIsoschizomers

void purgeIsoschizomers ()
purgeMethylationSites (line 1332)

purgeMethylationSites

void purgeMethylationSites ()
purgeReferences (line 1551)

purgeReferences

void purgeReferences ()
purgeVendors (line 1440)

purgeVendors

void purgeVendors ()
setCut (line 549)

setCut

void setCut ( $iCut)
  • $iCut
setIsoschizomers (line 1210)

setIsoschizomers

void setIsoschizomers ( $aIsoschizomers)
  • $aIsoschizomers
setIsPallindromic (line 1039)

setIsPallindromic

void setIsPallindromic ( $bIsPallindromic)
  • $bIsPallindromic
setIsPrototype (line 1095)

setIsPrototype

void setIsPrototype ( $bIsPrototype)
  • $bIsPrototype
setMethylationSites (line 1314)

setMethylationSites

void setMethylationSites ( $aMethylationSites)
  • $aMethylationSites
setMicrobe (line 1374)

setMicrobe

void setMicrobe ( $sMicrobe)
  • $sMicrobe
setName (line 253)

setName

Sets the restriction enzyme name This will also clean up the name. I have added this because some people get confused about restriction enzyme names. The name should be One upper case letter, and two lower case letters (because it is derived from the organism name, eg. EcoRI is from E. coli). After that it is all confused, but the numbers should be roman numbers not numbers, therefore we'll correct those. At least this will provide some standard, I hope.

  • Corrects & sets the restriction enzyme name
  • Overrides Seq->setName()
    1. $re->name('EcoRI')

  • return: void
: setName (string $sName)
  • string $sName
setPrototypeName (line 1158)

setPrototypeName

void setPrototypeName ( $sPrototypeName)
  • $sPrototypeName
setReferences (line 1533)

setReferences

void setReferences ( $aReferences)
  • $aReferences
setRevCompCut (line 652)

setRevCompCut

  • tutorial: $num = $re->setRevCompCut('1');
  • throws: Exception if argument is non-numeric.
  • uses: Sets/Gets - an integer indicating the position of cleavage on the reverse strand of the restriction site.
Integer setRevCompCut ($iCut $iCut)
  • $iCut $iCut: An integer
setRevCompSite (line 445)

setRevCompSite

void setRevCompSite ()
setSeq (line 307)

setSeq Sets the Sequence object for the enzyme.

  1. $re->setSeq($oSeq);

void setSeq (Dna $oSeq)
  • object $oSeq
setSite (line 370)

site Sets the recognition sequence for the enzyme.

Side effect: the sequence is always converted to upper case. The cut site can also be set by using methods L<cut|cut> and L<complementary_cut|complementary_cut>. This will pad out missing sequence with N's. For example the enzyme Acc36I cuts at ACCTGC(4/8). This will be returned as ACCTGCNNNN^ Note that the common notation ACCTGC(4/8) means that the forward strand cut is four nucleotides after the END of the recognition site. The forward cut() in the coordinates used here in Acc36I ACCTGC(4/8) is at 6+4 i.e. 10. This is the main setable method for the recognition site.

  1. $re->setSite($sSite);

  • return: string containing recognition sequence indicating cleavage site as in 'G^AATTC'.
string setSite (string $sSite)
  • string $sSite
setSource (line 1420)

setSource

void setSource ( $sSource)
  • $sSource
setVendors (line 1465)

setVendors

void setVendors ( $aVendors)
  • $aVendors
string (line 734)

string

void string ()
type (line 692)

type

void type ()
__call (line 214)

function __call

void __call (string $sMethod, array $aArguments)
  • string $sMethod
  • array $aArguments

Inherited Methods

Inherited From Bio

Bio::__construct()
Bio::printWithNl()
Class Constants

Inherited Constants

Inherited from Bio

Bio::NEWLINE

Documentation generated on Sun, 28 Sep 2008 11:09:33 +0200 by phpDocumentor 1.4.2