annotate deseq-hts_1.0/README @ 9:e27b4f7811c2 draft

Updated DESeq version 1.12
author vipints <vipin@cbio.mskcc.org>
date Tue, 08 Oct 2013 08:09:28 -0400
parents 8ab01cc29c4b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
1 ----------------------------------------------------
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
2 DESeq: A Galaxy wrapper for DESeq version 1.12.1
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
3 ----------------------------------------------------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
4
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
5 Description:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
6 ------------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
7 DESeq can be used as a web service embedded in a Galaxy instance.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
8 We call it as DESeq-hts.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
9
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
10 Requirements:
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
11 -------------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
12 MATLAB/OCTAVE and Python :- Preprocessing of sequencing reads and GFF files
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
13 R, Bio-conductor package :- Required for DESeq
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
14 SCIPY, NUMPY :- for python
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
15 SAMTOOLS :- Sequencing read processing
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
16
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
17 Contents:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
18 ---------
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
19 ./src
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
20 All relevant scripts for DESeq-hts are located in the subdirectory
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
21 src. src/deseq-hts.sh is the main script to start DESeq-hts. The
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
22 preprocessing of BAM and GFF file start before the R DESeq script.
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
23 Please follow the shell script to understand the details.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
24
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
25 ./galaxy
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
26 Galaxy tool configuration file can be found galaxy folder. Please
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
27 make necessary editing for .xml file and remaining .sh files and
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
28 perform few tests.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
29
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
30 ./setup_deseq-hts.sh
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
31 Setup script for DESeq-hts.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
32
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
33 ./mex
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
34 matlab executable files.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
35
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
36 ./bin
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
37 Contains deseq_config.sh file which is used for the configuration of
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
38 DESeq-hts. According to your platform, the default file will be changed.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
39
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
40 ./test_data
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
41 This sub-directory contains all data for running a functional test in
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
42 Galaxy framework. You may need to move these test files into the test-data
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
43 directory.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
44
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
45 ./tools
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
46 A python based GFF parsing program. Also contains small utils programs.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
47
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
48 Getting started:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
49 ----------------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
50 Check for all requirements first, then
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
51
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
52 a) Run ./setup_deseq-hts.sh and setup paths and configuration options for DESeq-hts.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
53
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
54 b) Inside the mex folder execute the make file to create platform dependent .mex files
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
55 cd mex/Makefile
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
56 make [interpreter]
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
57 make octave for octave
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
58 make matlab for matlab
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
59 make all for octave and matlab
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
60
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
61 c) Edit the Galaxy tool configuration file to adjust the path if necessary.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
62
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
63 Licenses:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
64 ---------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
65 If **DESeq** is used to obtain results for scientific publications it should be cited as [1].
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
66
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
67 This wrapper program (DESeq-hts) is free software; you can redistribute it and/or modify it
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
68 under the terms of the GNU General Public License as published by the Free Software Foundation;
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
69 either version 3 of the License, or (at your option) any later version.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
70
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
71 Written (W) 2009-2012 Jonas Behr, Regina Bohnert, Andre Kahles, Gunnar Raetsch, Vipin T. Sreedharan
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
72 Copyright (C) 2009-2012 Friedrich Miescher Laboratory of the Max Planck Society, Tubingen, Germany and
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
73 2013 cBio Memorial Sloan Kettering Cancer Center, New York City, USA.
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
74
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
75 References:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
76 -----------
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
77 [1] Anders, S and Huber, W (2010): `Differential expression analysis for sequence count data`.
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
78
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
79 Contributions:
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
80 --------------
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
81 15 Aug. 2013
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
82 Philippe Moncuquet
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
83 Bioinformatics Analyst, Bioinformatics Core, CSIRO Mathematics, Informatics and Statistics
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
84
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
85 Extended the DESeq result.
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
86
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
87 Contact:
9
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
88 --------
e27b4f7811c2 Updated DESeq version 1.12
vipints <vipin@cbio.mskcc.org>
parents: 1
diff changeset
89 support [at] oqtans.org
0
94a108763d9e deseq-hts version 1.0 wraps the DESeq 1.6.0
vipints
parents:
diff changeset
90