annotate rDiff/README @ 2:233c30f91d66

updated python based GFF parsing module which will handle GTF/GFF/GFF3 file types
author vipints <vipin@cbio.mskcc.org>
date Tue, 08 Oct 2013 07:15:44 -0400
parents 0f80a5141704
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
1 ---------------------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
2 rDiff version 0.3
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
3 ---------------------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
4 http://bioweb.me/rdiff
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
5
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
6 DESCRIPTION
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
7 -----------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
8 rDiff performs differential expression testing and
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
9 creates a list of gene names with corresponding
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
10 p-values.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
11
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
12 REQUIREMENTS
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
13 ------------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
14 - Octave/Matlab >=3.4
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
15 - Python >=2.6.5 and Scipy >=0.7.1
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
16 - SAMTools >= 0.1.7
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
17
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
18 GETTING STARTED
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
19 ---------------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
20 To install rDiff and the required software please
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
21 follow the instructions in INSTALL in this directory.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
22
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
23 CONTENTS
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
24 --------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
25 All relevant scripts for rDiff are located in the
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
26 subdirectory src. rdiff.sh is the main script to
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
27 start rDiff.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
28
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
29 ./bin
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
30 Contains rdiff_config.sh file which is used for the configuration.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
31 According to your platform, the default file will be changed.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
32
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
33 ./galaxy
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
34 Galaxy tool configuration files
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
35
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
36 ./tools
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
37 A python based GFF parsing program. Also contains small utils
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
38 programs.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
39
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
40 ./examples
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
41 This sub-directory contains all data for running a functional
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
42 tests.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
43
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
44 ./mex
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
45 matlab executable files.
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
46
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
47 LICENSE
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
48 -------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
49 rDiff is licensed under the GPL version 3 or any later version
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
50 (cf. LICENSE).
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
51
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
52 CITE US
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
53 -------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
54 If you use rDiff in your research you are kindly asked to cite
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
55 the following publication:
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
56
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
57 Philipp Drewe, Oliver Stegle, Lisa Hartmann, AndrĖe Kahles,
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
58 Regina Bohnert, Andreas Wachter, Karsten Borgwardt, Gunnar Raetsch,
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
59 Accurate Detection of Differential RNA Processing, NAR, 2013
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
60
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
61 COPYRIGHT
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
62 ---------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
63 Copyright (C)
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
64 2009-2012 Friedrich Miescher Laboratory of the Max Planck Society, Tubingen, Germany
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
65 2012-2013 Memorial Sloan-Kettering Cancer Center, New York City, USA
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
66
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
67 CONTACT
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
68 -------
0f80a5141704 version 0.3 uploaded
vipints
parents:
diff changeset
69 vipin@cbio.mskcc.org