Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
  • Loading branch information
lee212 committed Jun 16, 2015
1 parent 4609dfe commit 3c31985
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 26 deletions.
28 changes: 13 additions & 15 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Tutorial: Using MGEScan on Galaxy Workflow
.. _ref-mgescan-tutorial:

QuickStart
===============================================================================

Galaxy workflow is a web-based system to support data analysis on the web.
MGEScan, identifying LTR and non-LTR in genome sequences are available on the
Galaxy workflow with additional tools.
Galaxy scientific workflow which is a web-based workflow software to support
data analysis with various tools.

Overview
-------------------------------------------------------------------------------
Expand All @@ -13,7 +15,8 @@ with a sample dataset, D. melanogaster genome. A public server at Indiana
University (http://silo.cs.indiana.edu:38080) provides sample datasets and
MGEScan tools to try MGEScan on Galaxy without installation hassle.

.. tip:: Approximate 30 minutes
.. tip:: Approximate 3 hours and 30 minutes (including 3 hours computation
time)

Run MGEScan-LTR and MGEScan-nonLTR for D. melanogaster
-------------------------------------------------------------------------------
Expand All @@ -22,7 +25,7 @@ In this tutorial, we will try to run both MGEScan-LTR and MGEScan-nonLTR with
D. melanogaster genome dataset. You can find the dataset at the ``Shared Data``
menu on top and MGEScan tools on the left frame.

Galaxy/MGEScan Server
Access to Galaxy/MGEScan
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Open Galaxy/MGEScan at your web browser:
Expand Down Expand Up @@ -193,7 +196,7 @@ And click "Execute".
.. image:: images/rtm-nonltr.png

Computation Time
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------------------------------------

Our test case took 3 hours for analyzing LTR and nonLTR of ``D. melanogaster``:

Expand All @@ -202,7 +205,7 @@ Our test case took 3 hours for analyzing LTR and nonLTR of ``D. melanogaster``:
* Total: 3 hours

Results
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------------------------------------

Upon the MGEScan tools completion, the output files are accessible via Galaxy
in `gff3` format, a plain text, or an archived (e.g. tar.gz) file. You will
Expand All @@ -214,7 +217,7 @@ You can download the output files to your local storage, or get access to
Genome Browser with provided links.

Visualization: UCSC or Ensembl Genome Browser
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Your genomic data in a Generic Feature Format Version 3 (gff3) can be displayed
by a well known visualization tool such as UCSC or Ensembl Genome Browser on
Expand All @@ -235,7 +238,7 @@ Ensembl (Example View)
.. image:: images/rtm-ltr-gff3-ensembl.png

Additional Options
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There are other options to view results on a web interface or local.

Expand All @@ -247,13 +250,8 @@ There are other options to view results on a web interface or local.

.. image:: images/galaxy-download.png

Download Results
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Galaxy provides a dowload option to results of tools via a download icon.

Description of tools
-------------------------------------------------------------------------------
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

Each tool in Galaxy has its description to explain how to use.

Expand Down
31 changes: 20 additions & 11 deletions docs/source/workflow.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,42 @@
MGEScan on Galaxy Workflow
==============================
.. _ref-mgescan-workflow:

With Galaxy Workflow tools, each procedure of MGEScan can be described with input and output as its steps.
MGEScan Workflow
===============================================================================

With Galaxy Workflow tools, each procedure of MGEScan can be described with
input and output as its steps.

Galaxy Workflow Canvas
----------------------
-------------------------------------------------------------------------------

In Galaxy > Workflow > Edit, you can modify or update the MGEScan workflow on Galaxy Workflow Canvas.
In Galaxy > Workflow > Edit, you can modify or update the MGEScan workflow on
Galaxy Workflow Canvas.

.. image:: images/rtm-workflow-final-large.png


Registered Workflow in local
--------------------------
-------------------------------------------------------------------------------

Once you completed composing/updating workflow, you can save your work on local.

.. image:: images/rtm-private-workflow.png

Registered Workflow in public
-----------------------------
-------------------------------------------------------------------------------

Through Galaxy Public Workflow Website, your workflow can be shared with other scientists and researchers. MGEScan workflow has been registed on https://usegalaxy.org/workflow/list_published.
Through Galaxy Public Workflow Website, your workflow can be shared with other
scientists and researchers. MGEScan workflow has been registed on
https://usegalaxy.org/workflow/list_published.

.. image:: images/rtm-public-workflow.png

Overview of MGEScan Workflow (Draft)
----------------------------------------
-------------------------------------------------------------------------------

The published MGEScan workflow consists of LTR and non-LTR programs in parallel. LTR has four components including splitting scaffolds, pre-processing by repeatmasker, finding LTRs, and converting results in gff3 format.
The published MGEScan workflow consists of LTR and non-LTR programs in
parallel. LTR has four components including splitting scaffolds, pre-processing
by repeatmasker, finding LTRs, and converting results in gff3 format.

.. image:: images/rtm-retrotminer-image.svg

:ref:`Quick Start <ref-mgescan-tutorial>`

0 comments on commit 3c31985

Please sign in to comment.