swiss::de(3pm) [debian man page]
SWISS::DE(3pm) User Contributed Perl Documentation SWISS::DE(3pm) Name SWISS::DE.pm Description Each DE object represents one protein name. The container object for all names of an entry is SWISS::DEs Inherits from SWISS::BaseClass Attributes "text" The raw text of the protein name. Note: as SwissKnife works with both new and old DE line formats, for backward rcompatibility, with both formats everything is parsed and stored the same way as it was with the old format. Therefore the raw text for a name of type 'EC' e.g. 6.3.5.5 will be "EC 6.3.5.5" (instead of "6.3.5.5"). Other strings only present in old DE line text format ('precursor' flag and 'Allergen', 'antigen' strings) are also added in the stored raw text. The safe method to get the DE text is "toText" (with both the new and old DE line format), which for "EC=6.3.5.5" (new DE line format), will return "6.3.5.5" (DE object of 'EC' type). For "(EC 6.3.5.5)" (old DE line format), will return "EC 6.3.5.5" "category" The category of the protein name: 'RecName', 'AltName', 'SubName' (TrEMBL only) DE RecName: Full=CAD protein; DE Short=CAD; Here both names (DE objects), are of category 'RecName' Category can be set/modified using "category(string)" Note: with the old DE line format, this field is undef "type" The type of the protein name: 'Full', 'Short', 'EC' 'Allergen', 'CD_antigen', 'Biotech','INN' DE RecName: Full=CAD protein; DE Short=CAD; Here the first name (DE object), is of type 'Full', the second one is of type 'Short' Type can be set/modified using "type(string)" Note: with the old DE line format, this field is undef Standard methods new fromText toText ($addParen) addParen : (meaningful only with old DE line format) if set to true, the name will be surrounded by parentheses, but not the evidence tags, e.g. : '(UMP SYNTHASE){E1}'. Evidence Tags Each protein name (DE object) can have independent evidence tags. DE SubName: Full=Histone H3{EI1}; DE EC=3.4.21.9{EC3}; DE AltName: Full=Enterokinase{EC5}; The following methods have their prototype defined in SWISS::BaseClass instead of the direct parent of SWISS::DEs, SWISS::ListBase : addEvidenceTag deleteEvidenceTags getEvidenceTags getEvidenceTagsString hasEvidenceTag setEvidenceTags example : $evidenceTag = $entry->Stars->EV->addEvidence('P', 'DEfix', '-', 'v1.3'); $entry->DEs->head->addEvidenceTag($evidenceTag); The easiest way to read the evidence tags of a protein name is to use c<getEvidenceTagsString> that will return the evidence tags as a string with the enclosing {} brackets. If there are no evidence tags, will return an empty string. POD ERRORS
Hey! The above document had some coding errors, which are explained below: Around line 165: =back doesn't take any parameters, but you said =back =head1 Methods perl v5.10.1 2008-07-17 SWISS::DE(3pm)
Check Out this Related Man Page
SWISS::Entry(3pm) User Contributed Perl Documentation SWISS::Entry(3pm) Name SWISS::Entry Description Main module to handle SWISS-PROT entries. One Entry object represents one SWISS-PROT entry and provides an API for its modification. The basic concept is the idea of lazy parsing. If an Entry object is created from the entry in flat file format, the text is simply stored in the private text attribute of the entry object. The member objects of the entry are only created if they are dereferenced. Example This minimum program reads entries from a file in SWISS-PROT format and prints the primary accession number for each of the entries. Attributes The following attributes represent member objects. They can be accessed like e.g. $entry->IDs IDs ID line object ACs DTs DEs GNs OSs OCs Refs The reference block object CCs KWs DRs FTs Stars Object for the annotator's section stored in the ** lines. SQs The sequence object. Methods new Return a new Entry object initialize Initialise an Entry object and return it. update [force] Update an entry. The content of the member objects is written back into the private text attribute of the entry if necessary. If $force is true, an update of all member objects is forced. reformat Reformat all fields of an entry. fromText $text [, $fullParse[, $removeInternalComments]] Create an Entry object from the text $text. If $fullParse is true, the entry is parsed at creation time. Otherwise the individual line objects are only created if they are dereferenced. If $removeInternalComments is true, wild comments and indentation will be removed from the text before the parsing is done. [NOTE: wild comments are lines starting with a double asterisk located outside the Stars section, and indented lines are lines starting with spaces. Both are used internally by SWISS-PROT annotators during their work and excluded from internal and external releases.] toText [$insertInternalComments] Return the entry in flat file text format. If internal comments and indentation have been removed as specified in the parameters to fromText(), you may wish to reinsert them in the text output by setting $insertInternalComments to true. toFasta Return the entry in Fasta format. equal Returns True if two entries are equal, False otherwise The following methods are provided for your convenience. They are shortcuts for methods of the individual line objects. ID Returns the primary ID of the entry. AC Returns the primary AC of the entry. SQ Returns the sequence of the entry. EV Returns the EV (evidence) object of an entry. SWISS-PROT internal method. Data access methods text Returns the current text of the entry. Quick and dirty! No update of the text is performed before. database_code Is it a SWISS-PROT, TREMBL or TREMBLNEW entry? database_code tries to find it out. Return values are S for SWISS-PROT, 3 for TREMBL, Q for TREMBLNEW, ? for unknown. isFragment Returns true if the DE line indicates a fragment, or of the entry contains a NON_CONS or NON_TER feature. isCurated Returns 1 if the entry is a curated entry, 0 otherwise. SWISS-PROT internal use only. perl v5.10.1 2008-07-16 SWISS::Entry(3pm)