Difference between revisions of "Chado - Getting Started"

From GMOD
Jump to: navigation, search
m (Installation using an RPM)
(Chado From SVN: New svn url)
 
(92 intermediate revisions by 9 users not shown)
Line 1: Line 1:
==Description==
+
{{ComponentBox
 
+
|{{ChadoResourcesBoxItem}}
Chado is a relational schema that underlies many GMOD installations. It is capable of representing many of the broad classes of data frequently encountered in modern biology such as sequence, sequence comparisons, phenotypes, genotypes, ontologies, publications, and phylogeny. It has been designed to handle complex representations of biological knowledge and should be considered one of the most sophisticated relational schemas currently available in molecular biology. The price of this complexity is that the new user is advised to spend some time becoming familiar with its fundamentals.
+
| | | | | | |}}
  
 +
Chado is a [[Glossary#Database Schema|relational database schema]] that underlies [[GMOD_Users|many GMOD installations]]. It is capable of representing many of the general classes of data frequently encountered in modern biology such as sequence, sequence comparisons, phenotypes, genotypes, ontologies, publications, and phylogeny. It has been designed to handle complex representations of biological knowledge and should be considered one of the most sophisticated relational schemas currently available in molecular biology. The price of this capability is that the new user must spend some time becoming familiar with its fundamentals.
  
 
==Documentation==
 
==Documentation==
  
 +
* [[Introduction to Chado]]
 +
* [http://bioinformatics.oxfordjournals.org/cgi/content/abstract/23/13/i337?ijkey=QYeUct9uLSzefgk&keytype=ref Chado paper in Bioinformatics]
 +
* [[Chado Tutorial]]
 
* [[Chado Manual]]
 
* [[Chado Manual]]
 
* [[Chado FAQ|FAQ for Chado]]
 
* [[Chado FAQ|FAQ for Chado]]
* [[GMOD_-_Getting_Started|Getting Started with GMOD]]
+
* [[Chado_Tables|Chado Tables]]
 +
* [[Chado_Best_Practices|Chado Best Practices]]
 +
* [[Sample_Chado_SQL|Sample Chado SQL]]
 +
* [[PostgreSQL Performance Tips]]
  
 
==Modules==
 
==Modules==
Line 14: Line 21:
 
Chado is a modular schema, designed in such a way as to allow the addition of new modules for new data types. The existing modules are:
 
Chado is a modular schema, designed in such a way as to allow the addition of new modules for new data types. The existing modules are:
  
* [[Chado Audit Module|Audit]] - for database audits
+
{{ChadoModules}}
* [[Chado Companalysis Module|Companalysis]] - for data from computational analysis
+
* [[Chado Contact Module|Contact]] - for people, groups, and organizations
+
* [[Chado CV Module|Controlled Vocabulary (cv)]] - for controlled vocabularies and ontologies
+
* [[Chado Expression Module|Expression]] - for RNA and protein expresssion
+
* [[Chado General Module|General]] - for identifiers
+
* [[Chado Genetic Module|Genetic]] - for genetic data and genotypes
+
* [[Chado Library Module|Library]] - for descriptions of molecular libraries
+
* [[Chado Map Module|Map]] - for maps without sequence
+
* [[Chado Organism Module|Organism]] - for taxonomic data
+
* [[Chado Phenotype Module|Phenotype]] - for phenotypic data
+
* [[Chado Phylogeny Module|Phylogeny]] - for organisms and phylogenetic trees
+
* [[Chado Publication Module|Publication (pub)]] - for publications and references
+
* [[Chado Sequence Module|Sequence]] - for sequences and sequence features
+
* [[Chado Stock Module|Stock]] - for specimens and biological collections
+
* [[Chado WWW Module|WWW]] -
+
  
  
 
==Installation==
 
==Installation==
  
 +
First you will need database software, or Relational Database Management System (RDBMS). The recommended RDBMS for Chado currently is [http://www.postgresql.org/ Postgres]. Postgres is free software, usually used on a Unix operating system such as Linux or Mac OS X.  You can also install Postgres, and Chado, on Windows but most Chado installations are found on some version of Unix - you'll probably get the best support by choosing Unix.  (See [[Databases and GMOD]] for more discussion.)  Once you've installed your RDBMS you can install Chado.
  
===Chado From CVS===
 
  
To install Chado from source you can get Chado from the schema CVS.
+
===Download a Stable Release of Chado===
  
# Install the prerequisites listed in the [INSTALL document]
+
See [[Downloads]]
# Install [http://www.bioperl.org/ BioPerl]
+
# Install [http://search.cpan.org/search?query=go-perl go-perl]
+
#* Alternatively install the larger go-dev package from the [http://sourceforge.net/projects/geneontology/ Gene Ontology site at Sourceforge]
+
#* Make sure to set the <code>GO_ROOT</code> variable.
+
# Install {{CPAN|DBIx::DBStag}}
+
  
Now you can get an anonymous checkout of the gmod schema:
+
<!--
 +
* Go to [http://sourceforge.net/project/showfiles.php?group_id=27707 GMOD at Sourceforge]
 +
* Download the latest '''gmod''' (the Chado source code is contained within this package)
 +
* Follow the instructions in the  {{CVS|schema/chado/INSTALL.Chado}} file
 +
-->
  
cvs -d:pserver:anonymous@gmod.cvs.sourceforge.net:/cvsroot/gmod login
+
=== Chado From SVN ===
  
Enter blank password.
+
You can get the most up-to-date, not even released yet, version of Chado from [[Subversion]]. To get a copy of the latest Chado source, enter this at the command line:
  
  cvs -d:pserver:anonymous@gmod.cvs.sourceforge.net:/cvsroot/gmod co schema
+
  svn co https://svn.code.sf.net/p/gmod/svn/schema/trunk
  
Now cd to the schema/chado directory, and perform these steps:
+
Once the package has been downloaded <code>cd</code> to the <code>trunk/chado</code> directory.
  
perl Makefile.PL
+
Follow the instructions in the <tt>INSTALL.Chado</tt> file, including the installation of the prerequisites. Or read <tt>{{SF_SVN|schema/trunk/chado/INSTALL.Chado|INSTALL.Chado}}</tt> online.
make
+
sudo make install UNINST=1
+
make load_schema
+
make prepdb
+
make ontologies
+
  
===Installation using an RPM===
+
==Loading Data==
  
If you are running the Fedora Core 2 linux distribution or any Unix that uses <code>yum</code> and RPM files then installing many GMOD applications (e.g. Chado, GBrowse, and Textpresso and the prerequisites) is easy:
+
After completing these steps, you can load your chado schema with data in a number of ways:
  
# Modify your /etc/yum.conf file in the way described [http://www.biopackages.net/#Configuration here] on the Biopackages.net website.
+
* [[Load_RefSeq_Into_Chado|Load RefSeq into Chado HOWTO]]
# Issue the command <code>sudo yum update</code>.
+
* [[Load_GFF_Into_Chado|Load GFF into Chado HOWTO]]
# Issue the command <code>sudo yum install gmod</code>.
+
* Using [[XORT]]
  
See [http://www.biopackages.net/ biopackages.net] for more detail.
+
You can also use the application [[Apollo]] to curate data in Chado.
  
==Contacts==
+
== Mailing Lists ==
 
+
[https://lists.sourceforge.net/lists/subscribe/gmod-schema GMOD Schema Mailing List]
+
  
 +
{{MailingListsFor|Chado}}
  
 
==Pronunciation==
 
==Pronunciation==
Line 82: Line 67:
 
''Chado'' is usually pronounced [[Media:Chado.mp3|like this]].
 
''Chado'' is usually pronounced [[Media:Chado.mp3|like this]].
  
 
[[Category:To Do]]
 
 
[[Category:Chado]]
 
[[Category:Chado]]
 +
[[Category:Database Tools]]
 +
[[Category:GMOD Components]]

Latest revision as of 18:08, 13 February 2014

Status
  • Mature release
  • Active development
  • Active support
Resources

Chado is a relational database schema that underlies many GMOD installations. It is capable of representing many of the general classes of data frequently encountered in modern biology such as sequence, sequence comparisons, phenotypes, genotypes, ontologies, publications, and phylogeny. It has been designed to handle complex representations of biological knowledge and should be considered one of the most sophisticated relational schemas currently available in molecular biology. The price of this capability is that the new user must spend some time becoming familiar with its fundamentals.

Documentation

Modules

Chado is a modular schema, designed in such a way as to allow the addition of new modules for new data types. The existing modules are:


Installation

First you will need database software, or Relational Database Management System (RDBMS). The recommended RDBMS for Chado currently is Postgres. Postgres is free software, usually used on a Unix operating system such as Linux or Mac OS X. You can also install Postgres, and Chado, on Windows but most Chado installations are found on some version of Unix - you'll probably get the best support by choosing Unix. (See Databases and GMOD for more discussion.) Once you've installed your RDBMS you can install Chado.


Download a Stable Release of Chado

See Downloads


Chado From SVN

You can get the most up-to-date, not even released yet, version of Chado from Subversion. To get a copy of the latest Chado source, enter this at the command line:

svn co https://svn.code.sf.net/p/gmod/svn/schema/trunk

Once the package has been downloaded cd to the trunk/chado directory.

Follow the instructions in the INSTALL.Chado file, including the installation of the prerequisites. Or read INSTALL.Chado online.

Loading Data

After completing these steps, you can load your chado schema with data in a number of ways:

You can also use the application Apollo to curate data in Chado.

Mailing Lists

Mailing List Link Description Archive(s)
Chado gmod-schema All issues regarding Chado, Chado::AutoDBI, and Bio::Chado::Schema Gmane, Nabble (2010/05+), Sourceforge
gmod-schema-cmts Chado code updates. Sourceforge

Pronunciation

Chado is usually pronounced like this.