annotate ngsplot_galaxytoolshed_v1.0/ngsplot_intro/intro.xml @ 2:b2d5006b82b8 draft

Uploaded
author ngsplot
date Wed, 18 Mar 2015 15:43:54 -0400
parents
children 664fbd8919f3
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 #if $numsamples.numsamples2 == "1":
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
7 runNGSplot.pl
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
8 $genome_name
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
9
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
10 #else if $numsamples.numsamples2 == "5":
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
11 runNGSplot.pl
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
12 $genome_name
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
13
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
14 #end if:
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
15
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
16 <!--
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
17 <inputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
18 <param type="text" value="mm9" name="genome_name" label="Intro Text here..." help="" >
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
19 </param>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
20 </inputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
21 -->
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
22
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
23 <help>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
24
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
25 **WELCOME TO NGS.PLOT ON GALAXY**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
26
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
27 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
28
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
29 **HOW TO USE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
30
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
31 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'.
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
32
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
33 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
34
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
35 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
36
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
37 **INTRODUCTION**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
38
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
39 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
40
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
41 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
42
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
43 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
44
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
45 -----
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
46
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
47 **COMMERCIAL USE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
48
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
49 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
50
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
51 **HOW TO CITE**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
52
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
53 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
54
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
55 **CONTACT**
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
56
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
57 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
58
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
59 </help>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
60 <outputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
61 <!--
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
62 <data format="pdf" name="out_avg_png" />
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
63 <data format="pdf" name="out_hm_png" />
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
64 <data format="zip" name="out_zip"/>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
65 -->
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
66 </outputs>
b2d5006b82b8 Uploaded
ngsplot
parents:
diff changeset
67 </tool>