Difference between revisions of "GBrowse Tutorial"

From GMOD
Jump to: navigation, search
(Replaced 2009 Tutorial with 2010 Tutorial)
m (Turning page into more of a disambiguation-type affair with links to the different tutorials.)
Line 1: Line 1:
{| class="tutorialheader"
+
There are several [[GBrowse]] tutorials:
| align="right" | {{#icon: 2010SummerSchoolAmericas300.png|2010 GMOD Summer School - Americas||2010 GMOD Summer School - Americas}}
+
| {{TutorialTitleLine|[[GBrowse]]}}<br />
+
[[2010 GMOD Summer School - Americas]]<br />
+
May 6-9, 2010<br />
+
[[User:Scott|Scott Cain]]
+
|}
+
__NOTITLE__
+
  
 +
; [[GBrowse Tutorial 2012|GBrowse tutorial from 2012 GMOD Summer School]]
 +
: This tutorial was taught by [[User:Scott|Scott Cain]] at the [[2012 GMOD Summer School]]. It demonstrates setting up, configuring and using [[GBrowse]] with some sample data. GBrowse is provided on an Amazon Machine Image: see [[Cloud|GMOD in the Cloud]] for more information on getting a GMOD AMI.
 +
 +
; [[GBrowse Tutorial 2010|GBrowse tutorial from 2010 GMOD Summer School]]
 +
: This tutorial was originally taught by [[User:Scott|Scott Cain]] at the [[2010 GMOD Summer School - Americas]].  It walks you through setting up and running [[GBrowse]] with some sample data.  It provides a [[VMware]] image to work on, and relies heavily on the {{GBrowseAdminTutorialLink|GBrowse Administration Tutorial}}.
  
<div class="emphasisbox">
 
<center><span style="font-size: 140%">There are several [[GBrowse]] [[:Category:Tutorials|tutorials]]:</span></center>
 
 
; [http://www.openhelix.com/gbrowse GBrowse User Tutorial] at [http://www.openhelix.com OpenHelix]
 
; [http://www.openhelix.com/gbrowse GBrowse User Tutorial] at [http://www.openhelix.com OpenHelix]
 
: Demonstrates the GBrowse ''user'' interface.
 
: Demonstrates the GBrowse ''user'' interface.
Line 19: Line 15:
 
; [[GBrowse NGS Tutorial]]
 
; [[GBrowse NGS Tutorial]]
 
: Instructions on how to visualize [[next generation sequencing]] data in GBrowse using [http://samtools.sourceforge.net SAMtools].  The tutorial includes a starting [[VMware]] image, and uses the example data that comes with SAMtools.
 
: Instructions on how to visualize [[next generation sequencing]] data in GBrowse using [http://samtools.sourceforge.net SAMtools].  The tutorial includes a starting [[VMware]] image, and uses the example data that comes with SAMtools.
 
; This tutorial
 
: This tutorial was originally taught by [[User:Scott|Scott Cain]] at the [[2010 GMOD Summer School - Americas]].  It walks you through setting up and running [[GBrowse]] with some sample data.  It provides a [[VMware]] image to work on, and relies heavily on the {{GBrowseAdminTutorialLink|GBrowse Administration Tutorial}}.
 
 
</div>
 
 
 
__TOC__
 
 
 
= VMware =
 
{|
 
| valign="top" |This tutorial was taught using a [[VMware]] system image as a starting point.  If you want to start with that same system, download and install the ''Starting'' image.
 
 
'''''See [[VMware]] for what software you need to use a VMware system image, and for directions on how to get the image setup and running on your machine.'''''
 
|
 
{| style="margin-left: 1em; margin-top: 0; " class="wikitable"
 
! Download
 
|-
 
| align="center" | [ftp://ftp.gmod.org/pub/gmod/Courses/2010/SummerSchoolAmericas/GMODCourse2010Day1.vmwarevm.tar.gz Starting&nbsp;Image]<br>
 
[ftp://ftp.gmod.org/pub/gmod/Courses/2010/SummerSchoolAmericas/GMODCourse2010Day2.vmwarevm.tar.gz  Ending Image]<br />
 
|-
 
! Logins
 
|-
 
|
 
{| class="wikitable"
 
! Purpose
 
! Username
 
! Password
 
|-
 
| Shell
 
| gmod
 
| gmodamericas2010
 
|-
 
| MySQL
 
| root
 
| gmodamericas2010
 
|}
 
|}
 
|}
 
 
 
= Caveats =
 
{{TutorialCaveats}}
 
 
=Prerequisites=
 
 
Installed before using apt or cpan.
 
 
=Install GBrowse=
 
 
Easily installed via the cpan shell:
 
  <span class="enter">sudo cpan</span>
 
  cpan> <span class="enter">install Bio::Graphics::Browser2</span>
 
 
Which gets all of the prereqs that aren't installed on the machine.
 
 
=Tutorial=
 
 
Go to http://localhost/gbrowse
 
 
 
 
 
 
=Basic [[Chado]] Configuration (if we have time)=
 
 
{{CPAN|Bio::DB::Das::Chado}} was installed when we created the image, but I've since released a new version, so we can install the new version with the cpan shell:
 
 
  <span class="enter">sudo cpan</span>
 
  cpan> <span class="enter">install Bio::DB::Das::Chado</enter>
 
 
Simple config file in <tt>/etc/gbrowse2/pythium.conf</tt>
 
 
Some simple tweaks and additions:
 
 
*fix the dbi string
 
*add nucleotide matches
 
*strip out stuff that is in <tt>/etc/gbrowse2/GBrowse.conf</tt>
 
 
==Materialized views for searching==
 
 
Chado comes with a tool to materialize views written by developers at the [[:Category:SGN|SOL Genomics Network (SGN)]].  A materialized view is faster (at the expense of more disk space) to search than a regular view (which is really a query over potentially several tables).  To create a materialized view that makes searching a GBrowse [[Chado]] instance a faster, we can do this:
 
 
  <span class="enter">gmod_materialized_view_tool.pl -c</span>
 
 
which will ask us several obscure questions for which we need to provide obscure answers:
 
 
  Give your materialized view a name (word characters only):
 
  <span class="enter">all_feature_names</span>
 
 
  Where will this MV be located? (schemaname.tablename):
 
  <span class="enter">public.all_feature_names</span>
 
 
  A view with this name already exists; do you want to replace it
 
  with a materialized view? [y|n]
 
  <span class="enter">y</span>
 
 
  How often, in seconds, should the MV be refreshed?
 
  You can also type 'daily', 'weekly', 'monthly' (30 days), or 'yearly' (365 days):
 
  <span class="enter">weekly</span>
 
 
  Enter specifications for the materialized view, OR provide a file in which
 
  the specs are written ('? for help):
 
  <span class="enter">feature_id integer,name varchar(255)</span>
 
 
  Enter the SQL query for the materialized view,
 
  or a file containing only the query:
 
  <span class="enter">SELECT feature_id,CAST(substring(uniquename from 0 for 255) as varchar(255)) as name FROM feature UNION SELECT feature_id, name FROM feature where name is not null UNION SELECT fs.feature_id,s.name FROM feature_synonym fs, synonym s WHERE fs.synonym_id = s.synonym_id</span>
 
 
  Enter a comma separated list of fields to index (or return for none):
 
  <span class="enter">feature_id,name</span>
 
 
  Enter the SQL queries for special indexes,
 
  or a file containing only the query (or return for none):
 
  <span class="enter">create index all_feature_names_lower_name on all_feature_names (lower(name))</span>
 
 
  Enter 'y' to confirm, 'n' to re-enter data:
 
  <span class="enter">y</span>
 
  
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
 
[[Category:GBrowse]]
 
[[Category:GBrowse]]

Revision as of 22:37, 4 September 2012

There are several GBrowse tutorials:

GBrowse tutorial from 2012 GMOD Summer School
This tutorial was taught by Scott Cain at the 2012 GMOD Summer School. It demonstrates setting up, configuring and using GBrowse with some sample data. GBrowse is provided on an Amazon Machine Image: see GMOD in the Cloud for more information on getting a GMOD AMI.
GBrowse tutorial from 2010 GMOD Summer School
This tutorial was originally taught by Scott Cain at the 2010 GMOD Summer School - Americas. It walks you through setting up and running GBrowse with some sample data. It provides a VMware image to work on, and relies heavily on the GBrowse2 Admin Tutorial.
GBrowse User Tutorial at OpenHelix
Demonstrates the GBrowse user interface.
GBrowse2 Admin Tutorial
Step by step guide on how to configure and load data into GBrowse. Administration tutorials are available for both the GBrowse2 Admin Tutorial, and the earlier 1.x versions.
GBrowse NGS Tutorial
Instructions on how to visualize next generation sequencing data in GBrowse using SAMtools. The tutorial includes a starting VMware image, and uses the example data that comes with SAMtools.