annotate chromeister/README.md @ 0:4616cc3476d4 draft

Uploaded
author bitlab
date Sat, 15 Dec 2018 18:06:48 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
1 # chromeister
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
2 An ultra fast, heuristic approach to detect conserved signals in extremely large pairwise genome comparisons.
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
3
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
4 ## Requirements
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
5
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
6 GCC compiler (any version that is not completely outdated should do) and the R-base package (default R installation should do) with no extra packages.
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
7 Simply download the .zip and unzip it, or clone the repository (currently the active branch is "histo-kmer-ultra" DO NOT USE ANY OTHER).
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
8 Then issue the following commands:
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
9
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
10 cd chromeister/src && make all
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
11
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
12 You are ready to go!
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
13
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
14 ## Use
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
15
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
16 There are several ways in which CHROMEISTER can be used. The simplest one is to run a 1-vs-1 comparison and then compute the score and the plot.
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
17 To do so, use the binaries at the bin folder:
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
18
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
19 CHROMEISTER -query seqX -db seqY -out dotplot.mat && Rscript compute_score.R dotplot.mat
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
20
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
21 This will generate the comparison matrix, the plot of the comparison with the automatic scoring and the guides to be used in an exhaustive GECKO comparison.
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
22
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
23 More to be added soon!
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
24
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
25
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
26
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
27
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
28
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
29
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
30
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
31
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
32
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
33
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
34
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
35
4616cc3476d4 Uploaded
bitlab
parents:
diff changeset
36