GenDBWiki/CoreDocumentation: Difference between revisions

From BRF-Software
Jump to navigation Jump to search
No edit summary
 
(fixing more links...)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
= GenDB CORE Documentation
= GenDB CORE Documentation =


This section describes the basic steps for automatically annotating a genome using the scripts provided with the GenDB CORE package. Each script has a detailed usage message that is displayed when a script is executed without any arguments. Please take a look at the documentation of each script for alternative options or advanced features.
The GenDB CORE documentation is intended to provide some general background knowledge about the GenDB annotation system. You should read the following chapters if you are planning to setup the system in order to annotate genomes.  


* "import_EMBL_GBK.pl":  
* [[GenDBWiki/CoreDocumentation/CoreScripts|CoreScripts]]: This section describes the most important scripts for running a standard genome annotation pipeline.
* tool_creator.pl
* [[GenDBWiki/CoreDocumentation/RegionPrediction|RegionPrediction]]: In this part you can find a number of details about the GenDB region prediction components.
* submit_job.pl
* [[GenDBWiki/CoreDocumentation/FunctionPrediction|FunctionPrediction]]: Tools used for function prediction within the GenDB system are described here.
* export_EMBL_GBK.pl
* [[GenDBWiki/CoreDocumentation/AdditionalScripts|AdditionalScripts]]: Additional scripts for special purpose tasks are explained in this last section of the GenDB CORE documentation.
* delete_contig.pl
* delete_contig_with_feedback.pl


In addition to the scripts required for annotating a genome the GenDB CORE package includes a number of scripts for maintaining GenDB databases and projects listed below:
For writing your own programs using the GenDB API please take a look at the GenDB developer section and the API documentation.
 
* add_annotator.pl: This script can be used for adding a human annotator to a GenDB project database. Usually this is already done automatically by the GPMS.
* cleanup_database.pl: This script is checks a number of GenDB objects for consistency. Objects with illegal references e.g. to already deleted objects are removed and deleted automatically.
* optimize_tables.pl: Use this script after larger database operations like computing several tools in order to optimize all tables automatically.
* set_user_config.pl: A default user configuration can be transferred to a GenDB user account with this script.

Latest revision as of 10:20, 28 October 2011

GenDB CORE Documentation

The GenDB CORE documentation is intended to provide some general background knowledge about the GenDB annotation system. You should read the following chapters if you are planning to setup the system in order to annotate genomes.

  • CoreScripts: This section describes the most important scripts for running a standard genome annotation pipeline.
  • RegionPrediction: In this part you can find a number of details about the GenDB region prediction components.
  • FunctionPrediction: Tools used for function prediction within the GenDB system are described here.
  • AdditionalScripts: Additional scripts for special purpose tasks are explained in this last section of the GenDB CORE documentation.

For writing your own programs using the GenDB API please take a look at the GenDB developer section and the API documentation.