From: <no...@us...> - 2010-10-12 21:00:28
|
Revision: 23953 http://gmod.svn.sourceforge.net/gmod/?rev=23953&view=rev Author: nomi Date: 2010-10-12 21:00:13 +0000 (Tue, 12 Oct 2010) Log Message: ----------- Most of the changes in this doc were made in place on the Apollo web server but were never committed. 95% of these are simply conversions to strictly correct HTML (e.g., <br> rather than <BR>). I have also updated the Apollo mailing list URL and a few other hardcoded URLs. Modified Paths: -------------- apollo/trunk/doc/html/userguide.html Modified: apollo/trunk/doc/html/userguide.html =================================================================== --- apollo/trunk/doc/html/userguide.html 2010-10-12 17:32:38 UTC (rev 23952) +++ apollo/trunk/doc/html/userguide.html 2010-10-12 21:00:13 UTC (rev 23953) @@ -1,175 +1,176 @@ -<html> +<html><head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> -<head> + <title>Apollo User Guide</title> -</head> +</head><body bgcolor="#ffffff"> -<body bgcolor="#FFFFFF"> +<h1 align="center">Apollo User Guide </h1> -<H1 align=center>Apollo User Guide </H1> +<center><img src="images/apollosplash.jpg" height="240" width="529"> +<h2>Version 1.11.x<br>October 2009</h2> +</center> -<CENTER><img SRC="images/apollosplash.gerry.jpg" width=529 height=240> -<h2>Version 1.10.x<br>February 2009</h2> -</CENTER> - <h1>Table of Contents</h1> -<a href="#Introduction">Introduction</a><BR> -<UL> -<LI><a href="#Community">The Apollo community</a><BR> -<LI><a href="#Bugs">Reporting bugs</a><BR> -<LI><a href="#mailing">Apollo mailing list</a><BR> -</UL> -<a href="#Download">Installing Apollo</a><BR> +<a href="#Introduction">Introduction</a><br> +<ul> +<li><a href="#Community">The Apollo community</a><br> +</li><li><a href="#Bugs">Reporting bugs</a><br> +</li><li><a href="#mailing">Apollo mailing list</a><br> +</li></ul> +<a href="#Download">Installing Apollo</a><br> <a href="#StartingUp">Starting up</a> -<UL> -<LI><a href="#StartingUnix">Unix</a><BR> -<LI><a href="#StartingWindows">Windows or Mac</a><BR> -<LI><a href="#FirstView">The first view of Apollo</a> -<LI><a href="#stdout">Text output from Apollo</a> -</UL> +<ul> +<li><a href="#StartingUnix">Unix</a><br> +</li><li><a href="#StartingWindows">Windows or Mac</a><br> +</li><li><a href="#FirstView">The first view of Apollo</a> +</li><li><a href="#stdout">Text output from Apollo</a> +</li></ul> <a href="#Loading">Loading Data</a> -<UL> -<LI><a href="#ReadingXML">Reading Drosophila annotations</a><BR> -<LI><a href="#ChadoXMLAdapter">Reading Chado XML files</a><BR> -<LI><a href="#ChadoAdapter">Reading data directly from a Chado database</a><BR> -<LI><a href="#ReadingGFF">Reading Ensembl GFF files</a><BR> -<LI><a href="#ReadingGFF3">Reading GFF3 files</a><BR> -<LI><a href="#Reading_Ensembl_via_ensj">Reading Ensembl schema databases</a><BR> -<LI><a href="game-synteny.html">Reading cross-species comparative data in +<ul> +<li><a href="#ReadingXML">Reading Drosophila annotations</a><br> +</li><li><a href="#ChadoXMLAdapter">Reading Chado XML files</a><br> +</li><li><a href="#ChadoAdapter">Reading data directly from a Chado database</a><br> +</li><li><a href="#ReadingGFF">Reading Ensembl GFF files</a><br> +</li><li><a href="#ReadingGFF3">Reading GFF3 files</a><br> +</li><li><a href="#Reading_Ensembl_via_ensj">Reading Ensembl schema databases</a><br> +</li><li><a href="http://apollo.berkeleybop.org/current/game-synteny.html">Reading cross-species comparative data in GAME XML format and from chado JDBC - (synteny viewer)</a><BR> -<LI><a href="#ReadingGenbank">Reading GenBank or EMBL data</a><BR> -<LI><a href="#AnalysisAdapter">Reading raw analysis results</a><BR> -<LI><a href="#Layering">Layering data</a><BR> -<LI><a href="#CommandLine">Command-line arguments</a><BR> -<LI><a href="#Styles">Styles</a><BR> -</UL> + (synteny viewer)</a><br> +</li><li><a href="#ReadingGenbank">Reading GenBank or EMBL data</a><br> +</li><li><a href="#AnalysisAdapter">Reading raw analysis results</a><br> +</li><li><a href="#Layering">Layering data</a><br> +</li><li><a href="#CommandLine">Command-line arguments</a><br> +</li><li><a href="#Styles">Styles</a><br> +</li></ul> <a href="#DisplayPanels">The display panels</a> -<UL> -<LI><a href="#MainWindow">The main window</a> -<UL> -<LI><a href="#AnnotationsVsResults">Annotations vs. results</a><BR> -<LI><a href="#Splitters">Splitters</a><BR> -<LI><a href="#Zooming">Zooming and scrolling</a><BR> -<LI><a href="#MovingMouse">Moving using the mouse--centering the display</a><BR> -<LI><a href="#ZoomToSelected">Zoom to selected</a><BR> -<LI><a href="#GuideLine">The guide line</a><BR> -<LI><a href="#ShowReverse">Showing reverse complement</a><BR> -<LI><a href="#ShowStrand">Forward and reverse strands</a><BR> -<LI><a href="#FeatureDetail">Feature detail panels</a><BR> -</UL> -<li><a href="#Preferences">Preferences editor</a></li> -<LI><a href="#ApolloWindows">Apollo windows</a><BR> -<LI><a href="#WebBrowser">Apollo and Web browsers</a><BR> -<LI><a href="#Selection">Selection</a> -<UL> -<LI><a href="#SingleFeature">Selecting a single feature</a><BR> -<LI><a href="#MultipleFeature">Selecting multiple features</a><BR> -<LI><a href="#ShiftSelecting">Adding to a selection</a><BR> -<LI><a href="#Deselecting">Deselecting</a><BR> -</UL> -<LI><a href="#Annotations">Finding out more about annotations and results</a><BR> -<UL> -<LI><a href="#Linkout">Get info about features via Web</a><BR> -<LI><a href="#AnnotationInfo">Annotation info</a><BR> -<LI><a href="#AnnotationTree">The annotation tree</a><BR> -<LI><a href="#AnnotationMenu">Annotation menu</a><BR> -<LI><a href="#Bookmarks">Bookmarks</a><BR> -</UL> -</UL> -</UL> +<ul> +<li><a href="#MainWindow">The main window</a> +<ul> +<li><a href="#AnnotationsVsResults">Annotations vs. results</a><br> +</li><li><a href="#Splitters">Splitters</a><br> +</li><li><a href="#Zooming">Zooming and scrolling</a><br> +</li><li><a href="#MovingMouse">Moving using the mouse--centering the display</a><br> +</li><li><a href="#ZoomToSelected">Zoom to selected</a><br> +</li><li><a href="#GuideLine">The guide line</a><br> +</li><li><a href="#ShowReverse">Showing reverse complement</a><br> +</li><li><a href="#ShowStrand">Forward and reverse strands</a><br> +</li><li><a href="#FeatureDetail">Feature detail panels</a><br> +</li></ul> +</li><li><a href="#TypesPanel">The types panel</a><br> +</li><li><a href="#Preferences">Preferences editor</a></li> +<li><a href="#ApolloWindows">Apollo windows</a><br> +</li><li><a href="#WebBrowser">Apollo and Web browsers</a><br> +</li><li><a href="#Selection">Selection</a> +<ul> +<li><a href="#SingleFeature">Selecting a single feature</a><br> +</li><li><a href="#MultipleFeature">Selecting multiple features</a><br> +</li><li><a href="#ShiftSelecting">Adding to a selection</a><br> +</li><li><a href="#Deselecting">Deselecting</a><br> +</li></ul> +</li><li><a href="#Annotations">Finding out more about annotations and results</a><br> +<ul> +<li><a href="#Linkout">Get info about features via Web</a><br> +</li><li><a href="#AnnotationInfo">Annotation info</a><br> +</li><li><a href="#AnnotationTree">The annotation tree</a><br> +</li><li><a href="#AnnotationMenu">Annotation menu</a><br> +</li><li><a href="#Bookmarks">Bookmarks</a><br> +</li></ul> +</li></ul> + <a href="#SearchFunctions">Search functions</a> -<UL> -<LI><a href="#FindingBase">Finding a specific base</a><BR> -<LI><a href="#FindingFeature">Finding a feature</a><BR> -<LI><a href="#FindingSequence">Finding a subsequence</a><BR> -<LI><a href="#RegExp">Using regular expressions</a><BR> -</UL> +<ul> +<li><a href="#FindingBase">Finding a specific base</a><br> +</li><li><a href="#FindingFeature">Finding a feature</a><br> +</li><li><a href="#FindingSequence">Finding a subsequence</a><br> +</li><li><a href="#RegExp">Using regular expressions</a><br> +</li></ul> <a href="#FeatureDisplay">Specifying which features to display</a> -<UL> -<LI><a href="#CollapsedView">Collapsed view</a><BR> -<LI><a href="#ExpandedView">Expanded view</a><BR> -<LI><a href="#HidingFeature">Hiding features</a><BR> -<LI><a href="#ShowingFeature">Showing features</a><BR> -<LI><a href="#ResizeFeature">Resizing features</a><BR> -<LI><a href="#DashSets">Showing sequencing gaps in ESTs<BR> -<LI><a href="#NewSeqs">Hits to new sequences<BR> -<LI><a href="#FeatureLabels">Showing feature labels</a><BR> -<LI><a href="#BackgroundColor">Background colors</a><BR> -<LI><a href="#EvidencePanelOrientation">Changing orientation of evidence panel</a><BR> -</UL> +<ul> +<li><a href="#CollapsedView">Collapsed view</a><br> +</li><li><a href="#ExpandedView">Expanded view</a><br> +</li><li><a href="#HidingFeature">Hiding features</a><br> +</li><li><a href="#ShowingFeature">Showing features</a><br> +</li><li><a href="#ResizeFeature">Resizing features</a><br> +</li><li><a href="#DashSets">Showing sequencing gaps in ESTs<br> +</a></li><li><a href="#NewSeqs">Hits to new sequences<br> +</a></li><li><a href="#FeatureLabels">Showing feature labels</a><br> +</li><li><a href="#TypesPanelControl">Using the Types panel to control display of features</a><br> +</li><li><a href="#BackgroundColor">Background colors</a><br> +</li><li><a href="#EvidencePanelOrientation">Changing orientation of evidence panel</a><br> +</li></ul> <a href="#SequenceLevelFeatures">Sequence level features</a> -<UL> -<LI><a href="#ShowSequence">Showing the genomic sequence</a><BR> -<LI><a href="#SequenceWindow">Translating and saving sequence</a><BR> -<UL> -<LI><a href="#SavingSeq">Saving whole sequence</a><BR> -</UL> -<LI><a href="#StartStopCodons">Start and stop codons</a><BR> -<LI><a href="#EdgeMatches">Edge matches</a><BR> -<LI><a href="#SpliceSites">Non-consensus splice sites</a></h3> -<LI><a href="#Analyses">Analyses: GC content and restriction sites</a><BR> -<li><a href="#Analyses-remote">Analyses: Remote analysis services</a></li> <ul> +<li><a href="#ShowSequence">Showing the genomic sequence</a><br> +</li><li><a href="#SequenceWindow">Translating and saving sequence</a><br> +<ul> +<li><a href="#SavingSeq">Saving whole sequence</a><br> +</li></ul> +</li><li><a href="#StartStopCodons">Start and stop codons</a><br> +</li><li><a href="#EdgeMatches">Edge matches</a><br> +</li><li><a href="#SpliceSites">Non-consensus splice sites</a> +</li><li><a href="#Analyses">Analyses: GC content and restriction sites</a><br> +</li><li><a href="#Analyses-remote">Analyses: Remote analysis services</a></li> +<ul> <li><a href="#NCBI-BLAST">NCBI BLAST</a></li> <li><a href="#NCBI-PRIMER-BLAST">NCBI Primer BLAST</a></li> </ul> -<LI><a href="#Jalview">Viewing alignments</a><BR> -<LI><a href="#Graphs">Viewing graph data</a><BR> -</UL> -<a href="#Printing">Printing to file - Postscript output</a><BR> -<a href="#Links">Links to useful sequence analysis sites</a><BR> -<a href="#Help">Apollo help</a><BR> -<a href="#SoftwareUpdates">Checking for Apollo software updates</a><BR> +<li><a href="#Jalview">Viewing alignments</a><br> +</li><li><a href="#Graphs">Viewing graph data</a><br> +</li></ul> +<a href="#Printing">Printing to file - Postscript output</a><br> +<a href="#Links">Links to useful sequence analysis sites</a><br> +<a href="#Help">Apollo help</a><br> +<a href="#SoftwareUpdates">Checking for Apollo software updates</a><br> <a href="#MouseFunctions">Summary of mouse functions</a> -<P> +<p> <a href="#Edit">Using Apollo to edit annotations</a> -<UL> -<LI><a href="#Saving">Saving your annotations</a><BR> -<LI><a href="#Autosaving">Autosaving</a><BR> -<LI><a href="#TranscriptColoring">Transcript coloring</a><BR> -<LI><a href="#CreatingGene">Creating a new annotation</a><BR> -<LI><a href="#ModifyingGene">Modifying gene models</a><BR> -<LI><a href="#FlippingResult">Changing the strand of a result</a><BR> -<LI><a href="#ResultTag">Tagging a result with a comment</a><BR> -<LI><a href="#AnnotationText">Editing annotation text</a><BR> -<LI><a href="#ExonDetailEditor">Exon detail editor</a><BR> -<UL> -<LI><a href="#EDEConfig">Configuration options for the Exon Detail Editor</a><BR> -<LI><a href="#EDEUsing">Using the Exon Detail Editor</a><BR> -<LI><a href="#frame_shifts">Setting translational frame shifts</a><BR> -<LI><a href="#seq_errors">Indicating genomic sequencing errors</a><BR> -</UL> -<LI><a href="#SequenceAligner">Sequence Aligner</a><BR> -<UL> -<LI><a href="#SEQDNAView">The DNA view for the Sequence Aligner</a><BR> -<LI><a href="#SEQAAView">The AA view for the Sequence Aligner</a><BR> -</UL> -</UL> -<a href="#Configuration">Configuring Apollo</a><BR> -<UL> -<LI><a href="#apollo.cfg">apollo.cfg</a><BR> -<LI><a href="#StyleFiles">Style files</a><BR> -<LI><a href="#TiersFiles">Tiers files</a><BR> -</UL> -<a href="#source">Getting the source code</a><BR> -<a href="#Adapting">Adapting Apollo</a><BR> -<a href="#Contributed">Contributed Apollo Documentation</a><BR> -<a href="#acknowledgements">Acknowledgements</a><BR> +</p><ul> +<li><a href="#Saving">Saving your annotations</a><br> +</li><li><a href="#Autosaving">Autosaving</a><br> +</li><li><a href="#TranscriptColoring">Transcript coloring</a><br> +</li><li><a href="#CreatingGene">Creating a new annotation</a><br> +</li><li><a href="#ModifyingGene">Modifying gene models</a><br> +</li><li><a href="#FlippingResult">Changing the strand of a result</a><br> +</li><li><a href="#ResultTag">Tagging a result with a comment</a><br> +</li><li><a href="#AnnotationText">Editing annotation text</a><br> +</li><li><a href="#ExonDetailEditor">Exon detail editor</a><br> +<ul> +<li><a href="#EDEConfig">Configuration options for the Exon Detail Editor</a><br> +</li><li><a href="#EDEUsing">Using the Exon Detail Editor</a><br> +</li><li><a href="#frame_shifts">Setting translational frame shifts</a><br> +</li><li><a href="#seq_errors">Indicating genomic sequencing errors</a><br> +</li></ul> +</li><li><a href="#SequenceAligner">Sequence Aligner</a><br> +<ul> +<li><a href="#SEQDNAView">The DNA view for the Sequence Aligner</a><br> +</li><li><a href="#SEQAAView">The AA view for the Sequence Aligner</a><br> +</li></ul> +</li></ul> +<a href="#Configuration">Configuring Apollo</a><br> +<ul> +<li><a href="#apollo.cfg">apollo.cfg</a><br> +</li><li><a href="#StyleFiles">Style files</a><br> +</li><li><a href="#TiersFiles">Tiers files</a><br> +</li></ul> +<a href="#source">Getting the source code</a><br> +<a href="#Adapting">Adapting Apollo</a><br> +<a href="#Contributed">Contributed Apollo Documentation</a><br> +<a href="#acknowledgements">Acknowledgements</a><br> -<hr size=0> +<hr size="0"> <h1> -<a NAME="Introduction"></a>Introduction</h1> -<P> +<a name="Introduction"></a>Introduction</h1> +<p> Apollo is a genomic annotation viewer and editor. It was originally developed as a collaboration between the Berkeley Drosophila Genome Project (part of the FlyBase consortium) and The Sanger Institute in Cambridge, UK. It was used by the -FlyBase biologists to construct the <a href=http://www.fruitfly.org/annot/release3.html>Release 3</a> and 4 annotations</a> on the finished +FlyBase biologists to construct the <a href="http://www.fruitfly.org/annot/release3.html">Release 3</a> and 4 annotations on the finished <i>Drosophila melanogaster</i> genome, and has also been a primary vehicle for sharing these annotations with the community. -<P> +</p><p> Apollo allows researchers to explore genomic annotations at many levels of detail, and to perform expert annotation curation, all in a graphical environment. @@ -177,38 +178,38 @@ application that is easy to install and run on Windows, Mac OS X, or any Unix-type system (including Linux). Apollo is currently supported by NIH grant 1R01GM080203-01 from the National Institute of General Medical Sciences (NIGMS). -<P> +</p><p> The current Apollo team is: -<UL> +</p><ul> <li>Ed Lee (leader and chief developer)</li> <li>Nomi Harris</li> -<li>Mark Gibson</li> <li>Suzanna Lewis</li> -</UL> -<P>The original Apollo developers were: -<P> -<UL> +</ul> +<p>Previous Apollo developers were: +</p><p> +</p><ul> <li>Steve Searle</li> <li>Michele Clamp</li> <li>Suzanna Lewis</li> <li>John Richter</li> -</UL> -<P> +<li>Mark Gibson</li> +</ul> +<p> Other contributors have included: -<UL> -<LI>Sima Misra</LI> +</p><ul> +<li>Sima Misra</li> <li>Guanming Wu</li> <li>Jonathan Crabtree (Chado JDBC adapter)</li> <li>Vivek Iyer</li> <li>Craig Melsopp</li> -<LI>Chris Mungall</LI> +<li>Chris Mungall</li> <li>Colin Wiel</li> <li>Chris Wilks</li> <li>Olivier Arnaiz</li> -<LI>and all the FlyBase curators</LI> -</UL> +<li>and all the FlyBase curators</li> +</ul> -<a NAME="Community"></a><h3>The Apollo community</h3> +<a name="Community"></a><h3>The Apollo community</h3> An increasing number of research groups are using Apollo as a starting point for customizing their own annotation visualization tool. Because @@ -216,68 +217,66 @@ groups working on different organisms (fruitfly and human) with different types of data, it was specifically designed to be flexible and extensible. -The <a href=http://www.gmod.org>Generic Model Organism Database (GMOD) project</a>, which +The <a href="http://www.gmod.org/">Generic Model Organism Database (GMOD) project</a>, which aims to provide a complete ready-to-use toolkit for analyzing whole genomes, has adopted Apollo as its annotation workbench. Apollo is Open Source; the Apollo source code is all available at -<a href=http://sourceforge.net/project/showfiles.php?group_id=27707> -SourceForge</a> as part of the <a href=http://sourceforge.net/projects/gmod/>GMOD project</a>. +<a href="http://sourceforge.net/project/showfiles.php?group_id=27707"> +SourceForge</a> as part of the <a href="http://sourceforge.net/projects/gmod/">GMOD project</a>. -<a NAME="Bugs"></a><h3>Reporting bugs</h3> +<a name="Bugs"></a><h3>Reporting bugs</h3> Apollo is still under active development, and there are still many bugs--some we know about, and some we don't. -The bugs we know about are listed in the <a href="http://sourceforge.net/tracker/?func=browse&group_id=27707&atid=462763">SourceForge Apollo bug tracker</a>. +The bugs we know about are listed in the <a href="http://sourceforge.net/tracker/?func=browse&group_id=27707&atid=462763">SourceForge Apollo bug tracker</a>. If you encounter a problem that is not in the list of reported bugs, please -<a href=http://sourceforge.net/tracker/?func=add&group_id=27707&atid=462763> -submit a new bug report</a> or ask on the <a href=#mailing>Apollo mailing list</a>. +<a href="http://sourceforge.net/tracker/?func=add&group_id=27707&atid=462763"> +submit a new bug report</a> or ask on the <a href="#mailing">Apollo mailing list</a>. Please be as specific as possible when you report bugs--tell us which version of Apollo you're running, what dataset you were looking at, what operating system you're on (including the version number), and what you did that caused the bug. Also send us the -output from the Java console (see the section on <a href=#stdout>Text output +output from the Java console (see the section on <a href="#stdout">Text output from Apollo</a>). -<P> +<p> When you report a bug, <b>be sure to include your email address</b>. We may need to ask you questions in order to track down the bug, and you'll probably want to know when we've fixed it. You will not be added to any mailing lists or sent any other correspondence. -<P> +</p><p> Mac users, please note: the top-level menu item that says "About Apollo" purports to tell you the Apollo version number, but in fact it's telling you the version number of the installer. To get the correct Apollo version number, use the "About" item from Apollo's Help menu. -<a NAME="mailing"></a><h3>Apollo mailing list</h3> +<a name="mailing"></a></p><h3>Apollo mailing list</h3> -If you are interested in discussing Apollo with other users, you can join the <a -href=http://mail.fruitfly.org/mailman/listinfo/apollo>Apollo mailing list</a>. Traffic is low, +If you are interested in discussing Apollo with other users, you can join the <a href="https://lists.lbl.gov/sympa/info/apollo">Apollo mailing list</a>. Traffic is low, and your email address will not be made publicly visible or used for any other purpose. In order to reduce spam on the list, you must join in order to send messages to the list. -To unsubscribe from the mailing list, use <a href=http://mail.fruitfly.org/mailman/listinfo/apollo>the same Web form</a>. +To unsubscribe from the mailing list, use <a href="https://lists.lbl.gov/sympa/info/apollo">the same Web form</a>. -<P> -<h1> -<a NAME="Download"></a>Installing Apollo</h1> -<P> +<p> +</p><h1> +<a name="Download"></a>Installing Apollo</h1> +<p> Apollo is a Java application that you can download and run on your computer (Windows, Linux, or Mac OS X--earlier Mac versions are not -supported). You can get Apollo <a href=http://www.fruitfly.org/annot/apollo/>here</a>. +supported). You can get Apollo <a href="/">here</a>. When you install Apollo, a JVM is bundled with it, unless you are on Mac OS X. -<h3>Getting the appropriate Java on a Mac</h3> +</p><h3>Getting the appropriate Java on a Mac</h3> Apollo is now set up to run with JDK1.5 or 1.6, so make sure you have one of these versions of Java installed. -You will need Mac OS X 10.4+ to install JDK1.5. Please see <a href=http://www.apple.com/softwareupdate>Apple's instructions on how to do this</a>, using Software Updates. +You will need Mac OS X 10.4+ to install JDK1.5. Please see <a href="http://www.apple.com/softwareupdate">Apple's instructions on how to do this</a>, using Software Updates. (Apollo cannot run on older versions of Mac OS X.) -<P> +<p> Some versions of Mac OS X have Java issues--standalone Java applications (such as Apollo) may unexpectedly quit or not launch. You can perform a simple test to verify whether your computer is experiencing this issue. If it is, you will need to reinstall one or two -Java software updates to resolve the issue. Please <a target=_new -href=http://docs.info.apple.com/article.html?artnum=301380>look here</a> +Java software updates to resolve the issue. Please <a target="_new" href="http://docs.info.apple.com/article.html?artnum=301380">look here</a> for help. -<p> +</p><p> -<h3>Memory use</h3> +</p><h3>Memory use</h3> Apollo uses a lot of memory, largely due to the sheer size of the annotation data. In order to use Apollo, your computer will need to have @@ -285,17 +284,19 @@ will probably find that if you try to run more than one instance of Apollo at the same time, performance will suffer. Also note that if you load a very large region, Apollo will use up more memory. -<P> +<p> Keep in mind that other applications running on your -computer also use memory, so you will get better performance if you shut down other applications (Photoshop, Word, etc.) before you launch Apollo. +computer also use memory, so you will get better performance if you shut + down other applications (Photoshop, Word, etc.) before you launch +Apollo. -<P> +</p><p> Apollo checks twice a minute to make sure you still have enough free memory. If the free memory is getting very low (less than 5% of the the value defined as "Memory" in apollo.cfg), you will get a warning. If you have done or are planning to do any editing, you should save your work and then quit and restart Apollo. -<P> +</p><p> If you load many large regions into Apollo (such as cytological bands), it is possible that it will run out of memory despite the memory checks. Usually the behavior you'll see if this happens is that it will freeze up during loading, but @@ -303,51 +304,54 @@ Java console, you may see "java.lang.OutOfMemoryError". If this happens, you should exit Apollo and restart. -<h1> -<a NAME="StartingUp"></a>Starting up</h1> -<P> -<h2> -<a NAME="StartingUnix"></a>Unix</h2> +</p><h1> +<a name="StartingUp"></a>Starting up</h1> +<p> +</p><h2> +<a name="StartingUnix"></a>Unix</h2> From the directory where Apollo is installed, type -<UL> +<ul> <pre>./Apollo</pre> -</UL> +</ul> You should also be able to run Apollo from other directories by specifying the full path. -<P> -<h2> -<a NAME="StartingWindows"></a>Windows or Mac</h2> +<p> +</p><h2> +<a name="StartingWindows"></a>Windows or Mac</h2> Select the Apollo icon from your desktop or dock. -<P> -<B>Note for Mac users running Panther (10.3)</b>: +<p> +<b>Note for Mac users running Panther (10.3)</b>: Some security-related software updates on Panther interfere with Java and prevent Apollo from launching from the shortcut (you will see the icon bounce a few times and then stop, and no Apollo window comes up). We are looking into how to address that, but there are two workarounds. Either: -<LI> Upgrade your Mac to Tiger or Leopard; or<BR> -<LI> Launch Apollo from the command line. First, start a Terminal window (Applications -> Utilities -> Terminal). In the Terminal window, cd to the directory where you installed Apollo, usually /Applications/Apollo, and type ./bin/apollo (note the lowercase a):<BR> +</p><li> Upgrade your Mac to Leopard or Snow Leopard; or<br> +</li><li> Launch Apollo from the command line. First, start a Terminal +window (Applications -> Utilities -> Terminal). In the Terminal +window, cd to the directory where you installed Apollo, usually +/Applications/Apollo, and type ./bin/apollo (note the lowercase a):<br> <pre><dd>cd /Applications/Apollo -<dd>./bin/apollo</pre> +</dd><dd>./bin/apollo</dd></pre> You will see the text output from Apollo in the Terminal window, and an Apollo window should come up. -<P>Note: if you want to run Apollo from the command line, it will not be able +<p>Note: if you want to run Apollo from the command line, it will not be able to control which version of the Java virtual machine your Mac defaults to using (as it does if you run the installed Apollo). Please make sure that you are set up to use JDK version 1.5 or 1.6, rather than 1.3, which is the default on some older Macs. <br> -<h2> -<a NAME="FirstView"></a>The first view of Apollo</h2> -<P> +</p><h2> +<a name="FirstView"></a>The first view of Apollo</h2> +<p> When Apollo starts up you should see the Apollo splashscreen, which will stay up for a few seconds while the Apollo software loads. -<P> -<center><img SRC="images/apollosplash.gerry.jpg" alt="Apollo splash screen" width=529 height=240></center> -<P> +</p><p> +</p><center><img src="images/apollosplash.jpg" alt="Apollo splash screen" height="240" width="529"></center> +<p> You should then see a window offering various ways to find the region you are interested in. These will be discussed shortly. -<P> -<center><img SRC="images/loadgamefile.gif" width=601 height=186></center> -<P> -<h2><a NAME="stdout"></a>Text output from Apollo</h2> +</p><p> +</p><center><img src="images/loadgamefile.gif" height="186" width="601"></center> +<p> +</p><h2><a name="stdout"></a>Text output from Apollo</h2> Sometimes it's important to see the text output from Apollo--the messages it prints to inform the user about what it's doing. This is particularly @@ -357,11 +361,15 @@ $APOLLO_ROOT/logs/stdout.log<br> $APOLLO_ROOT/logs/stderr.log<br> <br> -where $APOLLO_ROOT is the location where Apollo was installed. Note that stdout/stderr are only captured into log files if you installed Apollo with the installer program. If you are running Apollo directly from the source code, stdout/stderr won't be redirected and will display on the terminal where you're invoking Apollo from.<br> +where $APOLLO_ROOT is the location where Apollo was installed. Note +that stdout/stderr are only captured into log files if you installed +Apollo with the installer program. If you are running Apollo directly +from the source code, stdout/stderr won't be redirected and will display + on the terminal where you're invoking Apollo from.<br> <h1> -<a NAME="Loading"></a>Loading Data</h1> -<P> -<h3><a NAME="ReadingXML"></a>Reading data from a file</h3> +<a name="Loading"></a>Loading Data</h1> +<p> +</p><h3><a name="ReadingXML"></a>Reading data from a file</h3> The oldest and, in many ways, most fully-functional data adapter in Apollo is the GAME XML adapter. The simplest way to try out Apollo is to choose the GAME XML adapter from the "Choose @@ -369,36 +377,36 @@ contains computational results and curated annotations for a region of the D. melanogaster genome), which is included with the Apollo distribution. -<h3><a NAME="ReadingXML"></a>Reading Drosophila annotation data</h3> +<h3><a name="ReadingXML"></a>Reading Drosophila annotation data</h3> The annotations on the <i>Drosophila melanogaster</i> genome are now stored in a version of the Chado XML format. Drosophila annotation data in Chado XML format can be read from a file or pulled transparently across the network from the FlyBase annotation database. -<P> +<p> Apollo provides several ways to search for the Drosophila region you are interested in: -<UL> -<LI>Filename (e.g., <i>data/CG16983.chado.xml</i>)--filenames can use absolute or relative +</p><ul> +<li>Filename (e.g., <i>data/CG16983.chado.xml</i>)--filenames can use absolute or relative paths (relative paths are taken to refer to files inside the Apollo directory). Please note that if you use the Browse button to select a file, you still need to hit the "Ok" button to begin loading the file. (You can also enter an URL as a filename.) -<P> A quick tip about the file chooser that is invoked by the Browse button: by default, it comes up in a mode where +<p> A quick tip about the file chooser that is invoked by the Browse button: by default, it comes up in a mode where you scroll horizontally to see all the available directories and files. If you prefer vertical scrolling, click on the icon at the top right of the chooser window, which looks like two little squares, each followed by a line. -<LI>Gene name (e.g., <i>cact</i>)--finds the region surrounding the gene -<LI>Cytological band (e.g., <i>40B</i>). Warning: these are big and use +</p></li><li>Gene name (e.g., <i>cact</i>)--finds the region surrounding the gene +</li><li>Cytological band (e.g., <i>40B</i>). Warning: these are big and use up a lot of memory. -<LI>Location: chromosome arm, start and end position (e.g., <i>3R 100000 300000</i>) -</UL> -<P> +</li><li>Location: chromosome arm, start and end position (e.g., <i>3R 100000 300000</i>) +</li></ul> +<p> By clicking on the tabs labeled "Gene", "Cytology", etc., you can decide how you want to look for the region of interest. Note that the FlyBase server will return the scaffold (~350Kb region) that is closest to your query, not the precise region you requested. -<P> -<center><img SRC="images/load-chado-xml.gif" width=710 height=248></center> -<P> +</p><p> +</p><center><img src="images/load-chado-xml.gif" height="248" width="710"></center> +<p> Note that except for the "File" search, all the searches go over the network to get the Drosophila annotations from the FlyBase server, so you must be connected to the internet to use them. Sometimes it takes a while to fetch the data across the @@ -407,40 +415,40 @@ message is that you might have a firewall that prevents the data from getting to your computer. If you use a proxy, be sure to set the proxy by clicking the "Proxy settings" button before trying to load data. -<P> +</p><p> If you'd like to download all the FlyBase Drosophila annotation data to your computer so you can then access it locally via the File tab, -please visit <a target=_new href=http://flybase.bio.indiana.edu/annot/>http://flybase.bio.indiana.edu/annot/</a>. +please visit <a target="_new" href="http://flybase.bio.indiana.edu/annot/">http://flybase.bio.indiana.edu/annot/</a>. -<h3> <a NAME="ChadoXMLAdapter"></a>Reading Chado XML or GAME XML files</a></h3> +</p><h3> <a name="ChadoXMLAdapter"></a>Reading Chado XML or GAME XML files</h3> The Chado XML adapter lets you read and write FlyBase-style Chado XML files with no macros. A sample Chado XML file containing some Drosophila annotations, data/CG16893.chado.xml, is included with the Apollo distribution. -<P> +<p> The Chado XML adapter has not yet been generalized for use with non-FlyBase data. Also, it cannot yet handle macros, and it doesn't yet deal with some types of "non-Apollo" data such as feature_cvterms. Theoretically, you can use Apollo as a converter between Chado XML and GAME, but we are still -debugging that conversion. Please see <a target=todo href=../todo>doc/todo</a> +debugging that conversion. Please see <a target="todo" href="http://apollo.berkeleybop.org/todo">doc/todo</a> for a list of known issues with the Chado XML adapter. -<P> -The <a href=http://www.fruitfly.org/annot/apollo/game.rng.txt>GAME XML</a> adapter +</p><p> +The <a href="/game.rng.txt">GAME XML</a> adapter was written to handle Drosophila data in the older GAME XML format. You should be able to use it to read other types of annotation data in GAME XML format, but you will need to change the tiers file. -<p> +</p><p> You can also write out two different GAME XML versions (1.0 and 1.1). This is configurable in style--set DO_ONE_LEVEL_ANNOTS "false" makes it save 1.0, otherwise it saves 1.1. -<p> +</p><p> -<h3> <a NAME="ChadoAdapter"></a>Reading data directly from a Chado database</h3> +</p><h3> <a name="ChadoAdapter"></a>Reading data directly from a Chado database</h3> The Chado JDBC adapter allows Apollo to read annotation data directly from a Chado database. Using this adapter to read data from your Chado database will require modification of some configuration files. -<P> +<p> If you want to try reading Drosophila annotations from the FlyBase Chado server (which might or might not still be running), select "Chado" from the data adapter list. There is only one database to choose: "FlyBase Chado Indiana @@ -449,34 +457,34 @@ the Sequence Ontology term for a scaffold). In the "Region ID" box, enter the gene name (if you selected type gene) or scaffold ID (if you selected golden_path_region). An example of a fruitfly gene is "cact". An -example scaffold ID is AE003603. <p> +example scaffold ID is AE003603. </p><p> The Chado adapter has known bugs that are described in -<a target=todo href=../chado/chado-jdbc-todo>doc/chado/chado-jdbc-todo</a>. For example, +<a target="todo" href="http://apollo.berkeleybop.org/chado/chado-jdbc-todo">doc/chado/chado-jdbc-todo</a>. For example, if you request a region that doesn't exist, Apollo will seize up. Also the dashed contig result lines that are present from the GAME Adapter are not coming up yet. See chado-jdbc-todo for the full listing. -<P> +</p><p> Also, if you ask the server for data by chromosome region (e.g., 2L:10000-20000), you may get an entire scaffold that includes the requested gene or region--not the actual region requested. This is a bug in the server, not Apollo (as of v. 1.6.5). -<P> +</p><p> The Chado data adapter can do direct-to-database writeback. It converts the transactions to updates to the chado database, so only edited features are updated in the database. Currently this is working with the Chado Rice database (at Cold Spring Harbor). Adapting it to other Chado databases shouldn't be too hard. -<P> +</p><p> If you are a developer who wants to enable Apollo to access your own Chado database, -please see the section about <a href=#CustomizingChadoAdapter>customizing the +please see the section about <a href="#CustomizingChadoAdapter">customizing the Chado adapter</a>. -<h3><a NAME="ReadingGFF"></a>Reading Ensembl GFF files</h3> +</p><h3><a name="ReadingGFF"></a>Reading Ensembl GFF files</h3> <a href="http://www.sanger.ac.uk/Software/formats/GFF">GFF</a> format is a simple format for transferring genomic annotations. A version of GFF (Ensembl GFF) is used at the Sanger Institute for storing the human annotations. -<P> +<p> To read in an Ensembl GFF file, choose the "Ensembl GFF" option from the data adapter menu. You can type your GFF file name in the text box or press the Browse button to bring up a file chooser. You can also enter a FASTA-format @@ -484,40 +492,60 @@ When you're ready, press the OK button and the GFF file (and sequence file, if you specified one) will be read in and the features displayed. -<P> -<center><img SRC="images/gff-adapter.gif" width=605 height=270></center> -<P>If any of the features in the GFF file have types that are not recognized +</p><p> +</p><center><img src="images/gff-adapter.gif" height="270" width="605"></center> +<p>If any of the features in the GFF file have types that are not recognized by Apollo they will be given a default pale yellow color. -This can be changed in the <a href="#Preferences">Preferences</a>section. -<P> +This can be changed in the <a href="#Preferences">Preferences</a> section or by right-clicking over the appropriate feature box in the <a href="#TypesPanel">Types panel</a>. +</p><p> Please note that there is more than one flavor of GFF, and Apollo only supports -the Ensembl flavor (as described <a href=http://www.sanger.ac.uk/Software/formats/GFF>here</a>). +the Ensembl flavor (as described <a href="http://www.sanger.ac.uk/Software/formats/GFF">here</a>). Apollo does <i>not</i> understand the Artemis flavor of GFF. -<P> +</p><p> Also note that Ensembl GFF format is not rich enough to support curated annotation, so even if you turn on editing, you will not be able to create and save curated annotations on GFF-format data. -<P> +</p><p> Finally, note that although theoretically Apollo can be used to convert between data formats (e.g. GFF <-> GAME), in practice this is not foolproof. -<h3><a NAME="ReadingGFF3"></a>Reading GFF3 files</h3> +</p><h3><a name="ReadingGFF3"></a>Reading GFF3 files</h3> <a href="http://www.sequenceontology.org/gff3.shtml">GFF3</a> format is -the current generation of a simple format for transferring genomic annotations. <P> -To read in an GFF3 file, choose the "GFF3 format" option from the data adapter menu. You can type your GFF3 file name in the text box or press the Browse button to bring up a file chooser. You must either provide the sequence data in FASTA format or you will need to have the FASTA data embedded in the GFF3 file. For the first option, make sure that "Embedded FASTA in GFF" is not checked and enter the FASTA file to go with the GFF3 data (you can browse for the file as well). For the second option, make sure that "Embedded FASTA in GFF" is checked. This will disable the "Sequence file" selection. When you're ready, press the OK button and the GFF3 file and sequence data will be read in and the features displayed. -<P> -<center><img SRC="images/gff3-adapter.gif" width=605 height=271></center> -<P>If any of the features in the GFF3 file have types that are not recognized +the current generation of a simple format for transferring genomic annotations. <p> +To read in an GFF3 file, choose the "GFF3 format" option from the data +adapter menu. You can type your GFF3 file name in the text box or press + the Browse button to bring up a file chooser. You must either provide +the sequence data in FASTA format or you will need to have the FASTA +data embedded in the GFF3 file. For the first option, make sure that +"Embedded FASTA in GFF" is not checked and enter the FASTA file to go +with the GFF3 data (you can browse for the file as well). For the +second option, make sure that "Embedded FASTA in GFF" is checked. This +will disable the "Sequence file" selection. When you're ready, press +the OK button and the GFF3 file and sequence data will be read in and +the features displayed. +</p><p> +</p><center><img src="images/gff3-adapter.gif" height="271" width="605"></center> +<p>If any of the features in the GFF3 file have types that are not recognized by Apollo they will be given a default pale yellow color. -This can be changed in the <a href="#Preferences">Preferences</a>section. -<P> +This can be changed in the <a href="#Preferences">Preferences</a> section or by right-clicking over the appropriate feature box +in the <a href="#TypesPanel">Types panel</a>. +</p><p> -<h3><a name="Reading_Ensembl_via_ensj"></a>Reading Ensembl schema databases</h3> - -The Ensembl project has created public MySQL databases of annotated genomes for many species - at time of writing this list includes human, mouse, mosquito, rat, zebrafish, and fugu. Each species is stored in a separate, publicly accessible database. The Ensembl adapter can read these databases, as well as any other ensembl-schema MySQL database. The Ensembl project's databases are at ensembldb.sanger.ac.uk, port 3306, accessible as user "anonymous". -<P> -To directly read Ensembl databases, use the File->Open menu as usual, and choose "EnsJ - Direct Access for Ensembl Databases (Schema 32 and above)" from the pulldown (note that it may freeze up briefly as it sets up its configuration). -<P> +</p><h3><a name="Reading_Ensembl_via_ensj"></a>Reading Ensembl schema databases</h3> +<p> +The Ensembl project has created public MySQL databases of annotated +genomes for many species - at time of writing this list includes human, + mouse, mosquito, rat, zebrafish, and fugu. Each species is stored in a + separate, publicly accessible database. The Ensembl adapter can read +these databases, as well as any other ensembl-schema MySQL database. The + Ensembl project's databases are at ensembldb.sanger.ac.uk, port 3306, +accessible as user "anonymous". +</p><p> +To directly read Ensembl databases, use the File->Open menu as usual, + and choose "EnsJ - Direct Access for Ensembl Databases (Schema 32 and + above)" from the pulldown (note that it may freeze up briefly as it +sets up its configuration). +</p><p> The EnsJ adapter is initially set to retrieve data from the Homo sapiens database at the ensembldb site, but because the database name changes frequently, the name that is hardcoded in the default Apollo history may no longer be valid. @@ -525,46 +553,71 @@ (.apollo/apollo.history) and restarting Apollo. Note that the list of databases may include some with schemas prior to the current one; if you try to read data from those, you will probably get an inscrutable error message. -<P> -After selecting a database (if the default one didn't work), you can select a region +</p><p> +After selecting a database (if the default one didn't work), you can +select a region to look at. The "Location" menu allows you to choose a specific gene to view: either by stable id (e.g. "ENSG00000187981"), -or by specifying a region of the chromosome (e.g. "Coordinate System: Chromosome (Version NCBI 35), SeqRegion: Chromosome 6, from 500,000 to 1,000,000"--choose "chromosome--NCBI35" for the coordinate system, "6" for the seq region name, and 500000-100000 for start-end). -<P> -To try out the EnsJ adapter, click the History pulldown list and select one of the pre-set regions. The relevant fields will be filled in appropriately, so you can just hit "Ok" at the bottom of the window to load the data. -<P><center><img SRC="images/ensj20_location.gif" width=462 height=419></center><P> +or by specifying a region of the chromosome (e.g. "Coordinate System: +Chromosome (Version NCBI 35), SeqRegion: Chromosome 6, from 500,000 to +1,000,000"--choose "chromosome--NCBI35" for the coordinate system, "6" +for the seq region name, and 500000-100000 for start-end). +</p><p> +To try out the EnsJ adapter, click the History pulldown list and select +one of the pre-set regions. The relevant fields will be filled in +appropriately, so you can just hit "Ok" at the bottom of the window to +load the data. +</p><p></p><center><img src="images/ensj20_location.gif" height="419" width="462"></center><p> Note that if you already had run a previous version of Apollo and thus have an apollo.history file in your .apollo directory, the pre-set EnsJ examples may not work right. You can fix this by removing .apollo/apollo.history (so that the new default history takes its place) or by filling in the spaces in the Data Source panel by hand (see the next subsection). -<P> -Ensembl features are categorised into various types. In order to see any of these types in the region you loaded, you must expand the "Types" panel by pushing the "Show/Hide Types" button. You will see the following: -<P><center><img SRC="images/ensj20_types.gif" width= height=></center><P> -The numbers beside each type (e.g., Genes (34270)) are the number of features of that type in the whole Ensembl database. Select the types of features you want to see ("Genes" is a good starting point). You must select something from this panel. At this point you should be ready to read data with the default data source configuration (human data at the public servers on ensembldb). You can hit the "OK" button on the dialog, and Apollo will bring up the selected annotations in your chosen region. -<P> -The "Types" button beside each feature type (eg "Gene Types...") will show a list of the different types of genes in the Ensembl database. For instance, in the homo sapiens database, there are many types such as protein_coding_KNOWN_ensembl and pseudogene_NOVEL_ensembl. -These types can be loaded individually by selecting them from this list which is sorted alphabetically. If no types are selected, all types will be loaded. +</p><p> +Ensembl features are categorized into various types. In order to see any + of these types in the region you loaded, you must expand the "Types" +panel by pushing the "Show/Hide Types" button. You will see the +following: +</p><p></p><center><img src="images/ensj20_types.gif" width="height="></center><p> +The numbers beside each type (e.g., Genes (34270)) are the number of +features of that type in the whole Ensembl database. Select the types of + features you want to see ("Genes" is a good starting point). You must +select something from this panel. At this point you should be ready to +read data with the default data source configuration (human data at the + public servers on ensembldb). You can hit the "OK" button on the +dialog, and Apollo will bring up the selected annotations in your +chosen region. +</p><p> +The "Types" button beside each feature type (eg "Gene Types...") will +show a list of the different types of genes in the Ensembl database. For + instance, in the homo sapiens database, there are many types such as +protein_coding_KNOWN_ensembl and pseudogene_NOVEL_ensembl. +These types can be loaded individually by selecting them from this list +which is sorted alphabetically. If no types are selected, all types will + be loaded. -<h4>Data Source Configurations</h4> +</p><h4>Data Source Configurations</h4> The Databases panel specifies where the ensembl database lives, and how to access it. We have set it up with some defaults, which should allow you to read human data "out of the box", but you might want to read ensembl data from some other species, or set up your own ensembl databases. -<P> -<P><center><img SRC="images/ensj20_database_config.gif" width= height=></center><P> -<P> -<b>Host</b>: The name of the host on which the ensembl databases live. The publicly accessible site (ensembldb.sanger.ac.uk) is defaulted in this field. If you set up your own ensembl database, or can see another ensembl database nearby, then you will change this field. -<BR> +<p> +</p><p></p><center><img src="images/ensj20_database_config.gif" width="height="></center><p> +</p><p> +<b>Host</b>: The name of the host on which the ensembl databases live. +The publicly accessible site (ensembldb.sanger.ac.uk) is defaulted in +this field. If you set up your own ensembl database, or can see another + ensembl database nearby, then you will change this field. +<br> <b>Port</b>: The port on which the database is "listening" for requests. For MySQL, this port is 3306 by default. -<BR> +<br> <b>User</b>: Who Apollo should log in as. The databases on ensembldb all have "anonymous" as the user. -<BR> +<br> <b>Password</b>: The public ensembl databases on ensembldb have no password for the user "anonymous", so you can leave this field blank. -<BR> +<br> <b>Ensembl Database Name</b>: This dropdown is only populated when you attempt to open it. It shows all the ensembl databases available on the @@ -572,32 +625,31 @@ field appropriate to the value of the "Data Source" dropdown. We have defaulted the database to the current human core database ("homo_sapiens_core_32_35e" at time of writing). -<P> +</p><p> Please note: the set of available ensembl databases is constantly changing, and your history may include databases that are no longer available, which can make the EnsJ adapter refuse to come up. If this seems to be happening to you, remove your ~/.apollo/apollo.history and try restarting Apollo. -<h4>Loading and saving manual annotations - otter format</h4> +</p><h4>Loading and saving manual annotations - otter format</h4> This functionality is still being redeveloped for the new EnsJ adapter. <h3>Reading cross-species comparative data</h3> -The still-under-development <a href=game-synteny.html>Synteny</a> viewer in Apollo lets you view comparative +The still-under-development <a href="http://apollo.berkeleybop.org/current/game-synteny.html">Synteny</a> viewer in Apollo lets you view comparative analyses between two genomes. There are several ways to read synteny data; currently, the default is GAME synteny, for which a pair of example files has been included with the Apollo distribution. -Please see the <a href=game-synteny.html>GAME Synteny user guide</a> +Please see the <a href="http://apollo.berkeleybop.org/current/game-synteny.html">GAME Synteny user guide</a> for more information. -<h3><a NAME="ReadingGenbank"></a>Reading GenBank or EMBL format</h3> +<h3><a name="ReadingGenbank"></a>Reading GenBank or EMBL format</h3> Apollo can now read GenBank and EMBL format from files or directly over the network (given an accession number). GenBank format looks like this: -<P> -<pre> -LOCUS AY308719 1036 bp DNA linear VRT 31-MAY-2004 +<p> +</p><pre>LOCUS AY308719 1036 bp DNA linear VRT 31-MAY-2004 DEFINITION Parus elegans mindanensis FMNH 357569 cytochrome b gene, partial cds; mitochondrial gene for mitochondrial product. ACCESSION AY308719 @@ -606,27 +658,25 @@ source 1..1036 /organism="Parus elegans mindanensis" </pre> -<P> -EMBL format looks like this:<P> -<pre> -ID DME9736 standard; genomic DNA; INV; 7411 BP. +<p> +EMBL format looks like this:</p><p> +</p><pre>ID DME9736 standard; genomic DNA; INV; 7411 BP. XX AC AJ009736; </pre> -<P> +<p> We are still working on this adapter. In particular, reading as GenBank or EMBL and then saving in GenBank format doesn't perfectly preserve everything from the original source. -<P> +</p><p> When you save in GenBank format, you have a choice of saving in a normal -human-readable GenBank file (as in the example above) or in <a target=_new href= -http://www.ncbi.nlm.nih.gov/Sequin/table.html>tabular format</a>, +human-readable GenBank file (as in the example above) or in <a target="_new" href="http://www.ncbi.nlm.nih.gov/Sequin/table.html">tabular format</a>, which is mostly used for submitting data to GenBank. If you want to save in tabular format, you must supply a <i>directory</i> name, not a file name; multiple files will be saved in the directory. To save in human-readable GenBank format, supply a file name. -<h3><a NAME="AnalysisAdapter"></a>Reading raw analysis results</h3> +</p><h3><a name="AnalysisAdapter"></a>Reading raw analysis results</h3> The analysis adapter (called "Computational analysis results" in the data loader menu) is one of the newest additions to Apollo; it still is in @@ -638,34 +688,34 @@ format. (However, keep in mind that you are responsible for running your own sequence analyses--Apollo does not and will not act as a "back end" and run the analyses itself, because they are too system-dependent.) -<P> +<p> Different tabs in the analysis adapter allow you to import various types of analysis results on your sequence: -<UL> -<LI> BLAST<BR> -<LI> sim4<BR> -<LI> blat<BR> -<LI> FgenesH<BR> -<LI> Genscan<BR> -<LI> tRNAscanSE<BR> -<LI> RepeatMasker -</UL> +</p><ul> +<li> BLAST<br> +</li><li> sim4<br> +</li><li> blat<br> +</li><li> FgenesH<br> +</li><li> Genscan<br> +</li><li> tRNAscanSE<br> +</li><li> RepeatMasker +</li></ul> Each one lets you specify a FASTA file containing the genomic query sequence that was used in the sequence analysis, and the tier and type to be used for displaying the data in Apollo. Some of the analysis tabs offer filtering/processing options, such as the minimum threshold for including BLAST hits. -<P> +<p> At the moment, many of the analysis parsers are not working right. Some of the sequence analysis programs, such as BLAT, seem to have changed their output format since the Apollo parsers were written. The BLAST and Genscan parsers seem to be the best ones right now. Stay tuned for more documentation and improved performance. In the meantime, if you have questions about the analysis adapter, please contact the -<a href=#mailing>Apollo mailing list</a>. -<P> +<a href="#mailing">Apollo mailing list</a>. +</p><p> The BLAST parser offers many filtering options. In most cases, you can just leave those alone. We hope in the future to reduce the complexity of the options. -<h4>Loading BLASTN results</h4> +</p><h4>Loading BLASTN results</h4> There are many different variations of BLAST format. The two main flavors of BLAST are NCBI BLAST and WU-BLAST. Theoretically, Apollo's BLAST parser should figure @@ -673,9 +723,9 @@ minor variations in BLAST output syntax can cause the parser to fail. As of August 2005, the parser seems to be working pretty well on NCBI BLASTN 2.2.11 output from the NCBI blast server -(<a target=_new href=http://www.ncbi.nlm.nih.gov/blast/Blast.cgi?CMD=Web&LAYOUT=TwoWindows&AUTO_FORMAT=Semiauto&ALIGNMENTS=50&ALIGNMENT_VIEW=Pairwise&CLIENT=web&DATABASE=chromosome&DESCRIPTIONS=100&ENTREZ_QUERY=%28none%29&EXPECT=10&FILTER=L&FORMAT_OBJECT=Alignment&FORMAT_TYPE=Text&NCBI_GI=on&PAGE=Nucleotides&PROGRAM=blastn&SERVICE=plain&SET_DEFAULTS.x=34&SET_DEFAULTS.y=8&SHOW_OVERVIEW=on&END_OF_HTTPGET=Yes&SHOW_LINKOUT=yes&GET_SEQUENCE=yes>http://www.ncbi.nlm.nih.gov/blast/Blast.cgi</a>). +(<a target="_new" href="http://www.ncbi.nlm.nih.gov/blast/Blast.cgi?CMD=Web&LAYOUT=TwoWindows&AUTO_FORMAT=Semiauto&ALIGNMENTS=50&ALIGNMENT_VIEW=Pairwise&CLIENT=web&DATABASE=chromosome&DESCRIPTIONS=100&ENTREZ_QUERY=%28none%29&EXPECT=10&FILTER=L&FORMAT_OBJECT=Alignment&FORMAT_TYPE=Text&NCBI_GI=on&PAGE=Nucleotides&PROGRAM=blastn&SERVICE=plain&SET_DEFAULTS.x=34&SET_DEFAULTS.y=8&SHOW_OVERVIEW=on&END_OF_HTTPGET=Yes&SHOW_LINKOUT=yes&GET_SEQUENCE=yes">http://www.ncbi.nlm.nih.gov/blast/Blast.cgi</a>). (This link is also available on Apollo's Links menu.) -<P> +<p> Select "chromosomes" as the database. You can select an organism or category of organisms in the Options section. Be sure the last pulldown list on the first row of the Format section says "Plain text". @@ -685,7 +735,7 @@ is to select all the BLAST result text in the browser window (some browsers have "Select all" under the Edit menu), copy it, and paste it into a plain text file (be sure the lines don't wrap). -<h3><a NAME="Layering"></a>Layering data</h3> +</p><h3><a name="Layering"></a>Layering data</h3> Some of the data adapters are able to "layer" features that are from the same genomic region. For example, you might have separate files of @@ -694,26 +744,33 @@ what you've already loaded. This only makes sense if the new data is from the same genomic region--if it's from a different region, you will probably get a blank popup error box. -<P> +<p> Another popular use of the layering option is to add new analysis results for the current region--for example, maybe you BLASTed the currently displayed genomic sequence against a new database, and want to see the results displayed along with the other evidence. To do this, use the "Layer more results or annotations" command from the File menu, and choose the "Computational analysis results" data loader from the pulldown list under "Choose data source". -<P> +</p><p> If you are preparing your own data files for layering, please note that you must identify the genomic region (e.g. chromosome arm) in each file (even if you don't include the sequence residues), so that Apollo knows where the features go. -<P> -The most common scenario for layering BLAST results is that you've already loaded -the annotations for some genomic region (say, D. melanogaster 2L:12345-67890); you -then BLASTN an EST against the D. melanogaster chromosomes (see the section on Loading BLASTN results above), and you want to see -where it matches your currently loaded region. To do this, use the "Computational analysis -results" data adapter, and select the BLAST tab. The checkbox that says "I used -the current genomic sequence (or a portion thereof) as my BLAST query" should -remain unchecked (the default) and you will not need to enter a genomic offset. -<P><center><img SRC="images/layer-blast.gif"></center><P> +</p><p> +The most common scenario for layering BLAST results is that you've +already loaded +the annotations for some genomic region (say, D. melanogaster +2L:12345-67890); you +then BLASTN an EST against the D. melanogaster chromosomes (see the +section on Loading BLASTN results above), and you want to see +where it matches your currently loaded region. To do this, use the +"Computational analysis +results" data adapter, and select the BLAST tab. The checkbox that says + "I used +the current genomic sequence (or a portion thereof) as my BLAST query" +should +remain unchecked (the default) and you will not need to enter a genomic +offset. +</p><p></p><center><img src="images/layer-blast.gif"></center><p> When you load your BLAST results, Apollo will display only the hits against the currently loaded chromosome or chromosome arm (but some of them may be to a different region of the chromosome). This capability is still @@ -723,20 +780,24 @@ that BLAST assumes all query sequences are on the + strand--it doesn't have a notion of a query sequence being on the - strand. The hits will therefore all show up relative to the + strand of the current region. -<P> +</p><p> Another thing to be aware of (unless this has been fixed recently) is that the chromosome coordinates on the D. melanogaster data from FlyBase don't match the coordinates from NCBI, so if you load a Drosophila region and try to layer NCBI BLAST hits, they will not show up in the right place--they'll appear somewhat shifted to the 3' end. This is a data problem, not an Apollo bug, though there are very likely bugs in Apollo's BLAST parser as well. -<P> +</p><p> If you BLASTed some or all of the current genomic sequence against a -database at NCBI, you should check off "I used the current genomic sequence -(or a portion thereof) as my BLAST query." If you used only a portion of -the current genomic sequence, enter the offset of the sequence you used from the starting position of the current genomic region (we plan to automate this offset calculation soon). +database at NCBI, you should check off "I used the current genomic +sequence +(or a portion thereof) as my BLAST query." If you used only a portion +of +the current genomic sequence, enter the offset of the sequence you used +from the starting position of the current genomic region (we plan to +automate this offset calculation soon). -<h2><a NAME="CommandLine"></a>Launching Apollo with command-line arguments</h2> +</p><h2><a name="CommandLine"></a>Launching Apollo with command-line arguments</h2> Unix users can launch Apollo on a datafile by using the appropriate command-line arguments. Use "--help" to get a list of the options. Valid arguments are: <pre> @@ -779,27 +840,30 @@ files into a DB (chado) -? (or --help) Show this help message </pre> -The command-line arguments changed starting with release 1.5.0, but for now -most of the older command-line arguments (e.... [truncated message content] |