annotate ngsplot_galaxytoolshed_v.10/ngsplot_intro/intro.xml @ 12:f7debdafc7cb draft default tip

Uploaded
author ngsplot
date Tue, 31 Mar 2015 10:15:27 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
1 <tool id="ngs.plot_intro" name="Introduction">
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
2 <command interpreter="perl">
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
3
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
4 </command>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
5
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
6 <!--
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
7 <inputs>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
8 <param type="text" value="mm9" name="genome_name" label="Intro Text here..." help="" >
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
9 </param>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
10 </inputs>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
11 -->
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
12
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
13 <help>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
14
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
15 **WELCOME TO NGS.PLOT ON GALAXY**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
16
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
17 -----
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
18
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
19 **HOW TO USE**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
20
f7debdafc7cb Uploaded
ngsplot
parents:
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'.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
22
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
23
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
24 (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://github.com/shenlab-sinai/ngsplot.)
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
25
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
26 -----
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
27
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
28 **INTRODUCTION**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
29
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
30 ngs.plot is a program that allows you to easily visualize your next-generation sequencing (NGS) samples at functional genomic regions.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
31
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
32 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.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
33
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
34 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://github.com/shenlab-sinai/ngsplot or to the publication cited below.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
35
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
36 -----
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
37
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
38 **COMMERCIAL USE**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
39
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
40 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
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
41
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
42 **HOW TO CITE**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
43
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
44 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.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
45
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
46 **CONTACT**
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
47
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
48 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.
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
49
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
50
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
51 </help>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
52 <outputs>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
53 </outputs>
f7debdafc7cb Uploaded
ngsplot
parents:
diff changeset
54 </tool>