annotate ngsplot_galaxytoolshed_v1.0/ngsplot_intro/intro.xml @ 10:6f396d9a518c draft

Uploaded
author ngsplot
date Thu, 19 Mar 2015 17:36:17 -0400
parents a011d3385b3f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
1 <tool id="ngs.plot_intro" name="Introduction">
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
2 <command interpreter="perl">
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
3
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
4 </command>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
5
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
6 <!--
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
7 <inputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
8 <param type="text" value="mm9" name="genome_name" label="Intro Text here..." help="" >
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
9 </param>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
10 </inputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
11 -->
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
12
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
13 <help>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
14
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
15 **WELCOME TO NGS.PLOT ON GALAXY**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
16
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
17 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
18
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
19 **HOW TO USE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
20
8
bb51014370e1 Uploaded
ngsplot
parents: 7
diff changeset
21 To use ngs.plot here on this GUI-based Galaxy implementation, first upload your alignment BAM file(s) using the *Get Data* -> **Upload File** tool on top of the left panel of this page. The names of your uploaded file(s) will then be displayed on the right panel. Next, select the *NGS.PLOT V2.47.1* -> **ngs.plot** tool on the left panel and all other input information required from you will be displayed as a form on the main central panel. Complete the form then click the *Execute* button to launch the program. Three output files (a profile chart, a heatmap, and a zipped data file) will be generated and displayed on the right panel, which you can click on to view. To further replot the figures into a format that you desire, use the *NGS.PLOT V2.47.1* -> **replot** tool with it's input file being the zip file previously generated by 'ngs.plot'.
2
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
22
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
23 For a more detailed explanation of how to run ngs.plot on Galaxy, please see the tutorial at https://code.google.com/p/ngsplot/wiki/webngsplot.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
24
9
a011d3385b3f Uploaded
ngsplot
parents: 8
diff changeset
25 (Note: installation of this Galaxy implementation of ngs.plot directly from the Galaxy Toolshed requires ngs.plot v2.47.1 to be already installed on your system. For instructions on the system installation of ngs.plot, please see https://code.google.com/p/ngsplot/.)
8
bb51014370e1 Uploaded
ngsplot
parents: 7
diff changeset
26
2
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
27 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
28
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
29 **INTRODUCTION**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
30
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
31 ngs.plot is a program that allows you to easily visualize your next-generation sequencing (NGS) samples at functional genomic regions.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
32
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
33 DNA sequencing is at the core of genomics. The NGS technology has been tremendously improved in the past few years. It can now determine more than a billion DNA sequences within a week, generating terabytes of data. Applications include but are not limited to: 1. ChIP-seq which profiles genome-wide protein-DNA interactions; 2. RNA-seq which measures the gene expression levels. It is very helpful to look at the enrichment of those sequences at various functional regions. Although a genome browser (such as the UCSC genome browser) allows a researcher to visualize these data, it limits the view to a slice of the genome. While the genome is like a huge collection of functional elements that can be classified into different categories. Each category of elements may perform distinct functions and they might further contain modules.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
34
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
35 The signature advantage of ngs.plot is that it collects a large database of functional elements for many genomes. A user can ask for a functionally important region to be displayed in one command. It handles large sequencing data efficiently and has only modest memory requirement. For example, ngs.plot was used to draw a plot for all the genes on the mouse genome from 71GB of ChIP-seq data in 25 min, with a memory footprint of 2.7GB using 4 x 2.4GHz CPU cores. ngs.plot is also easy to use. A user only needs to create a very small text file called configuration, telling the program which samples to look at and how they should be combined with different regions, and then run the program with one command. This Galaxy web-based version of ngs.plot is also available for users not familiar with command-line programs. For additional program details, please refer to our project homepage at https://code.google.com/p/ngsplot or to the publication cited below.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
36
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
37 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
38
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
39 **COMMERCIAL USE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
40
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
41 ngs.plot is free for use by academic users. If you want to use it in commercial settings, please contact Lisa Placanica at: lisa.placanica@mssm.edu
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
42
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
43 **HOW TO CITE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
44
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
45 Shen, L.*, Shao, N., Liu, X. and Nestler, E. (2014) ngs.plot: Quick mining and visualization of next-generation sequencing data by integrating genomic databases, BMC Genomics, 15, 284.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
46
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
47 **CONTACT**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
48
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
49 ngs.plot is developed by Drs. Li Shen, Ningyi Shao and Xiaochuan Liu at the Icahn School of Medicine at Mount Sinai. If you have technical questions about ngs.plot, please use the discussion forum. For collaborations or any other matters, use: li.shen AT mssm.edu.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
50
6
664fbd8919f3 Uploaded
ngsplot
parents: 2
diff changeset
51
2
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
52 </help>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
53 <outputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
54 </outputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
55 </tool>