annotate chromeister/README.md @ 0:7fdf47a0bae8 draft

Uploaded
author alvarofaure
date Wed, 12 Dec 2018 07:18:40 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
1 # chromeister
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
2 An ultra fast, heuristic approach to detect conserved signals in extremely large pairwise genome comparisons.
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
3
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
4 ## Requirements
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
5
7fdf47a0bae8 Uploaded
alvarofaure
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.
7fdf47a0bae8 Uploaded
alvarofaure
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).
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
8 Then issue the following commands:
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
9
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
10 cd chromeister/src && make all
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
11
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
12 You are ready to go!
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
13
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
14 ## Use
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
15
7fdf47a0bae8 Uploaded
alvarofaure
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.
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
17 To do so, use the binaries at the bin folder:
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
18
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
19 CHROMEISTER -query seqX -db seqY -out dotplot.mat && Rscript compute_score.R dotplot.mat
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
20
7fdf47a0bae8 Uploaded
alvarofaure
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.
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
22
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
23 More to be added soon!
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
24
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
25
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
26
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
27
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
28
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
29
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
30
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
31
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
32
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
33
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
34
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
35
7fdf47a0bae8 Uploaded
alvarofaure
parents:
diff changeset
36