annotate README.rdoc @ 2:e16016635b2a

Uploaded
author timpalpant
date Mon, 13 Feb 2012 22:12:06 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
1 = Java Genomics Toolkit
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
2
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
3 This is a collection of applications for genomics data processing, primarily high-throughput next-generation sequencing. There is a particular focus on processing data in Wiggle format, since many other tools already cover SAM, BAM, FastQ, etc. However, Wiggle/BigWig formats provide a compact way to store numerical data resulting from ChIP-seq and MNase-seq experiments. Common computations provided in this toolkit include adding, subtracting, dividing, multiplying, log-transforming, averaging, Z-scoring, and Gaussian smoothing Wig files.
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
4
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
5 Tools may be run from the command-line, a simple Swing GUI, or from Galaxy (http://getgalaxy.org).
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
6
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
7 == Loading the Tools into Galaxy
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
8
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
9 TODO
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
10
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
11 == Using the ToolRunner GUI
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
12
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
13 TODO
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
14
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
15 == Command-Line Usage
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
16
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
17 Applications can be run on the command-line, and the toolRunner.sh script is provided for convenience. Calling any script without arguments will display the help, as well as the missing mandatory arguments:
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
18
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
19 $ > ./toolRunner.sh wigmath.AddWig
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
20 $ Usage: <main class> [options] Input files
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
21 $ Options:
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
22 $ * -o, --output Output file
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
23
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
24 Mandatory arguments are denoted with a (*).
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
25
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
26 Other tools require more input:
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
27
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
28 $ > ./toolRunner.sh ngs.Autocorrelation
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
29 $ Usage: <main class> [options]
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
30 $ Options:
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
31 $ * -i, --input Input file
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
32 $ * -l, --loci Genomic loci (Bed format)
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
33 $ -m, --max Autocorrelation limit (bp)
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
34 $ Default: 200
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
35 $ * -o, --output Output file
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
36
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
37 === Log transform a Wig file with base 2
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
38
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
39 $ > ./toolRunner.sh wigmath.LogTransform --input input.wig --base 2 --output output.log2.wig
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
40
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
41 == Java Genomics IO
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
42
e16016635b2a Uploaded
timpalpant
parents:
diff changeset
43 Those wishing to write their own scripts may be interested in https://github.com/timpalpant/java-genomics-io, the toolkit upon which these applications are built.