annotate chromeister/README.md @ 0:ee6b15b409e5 draft

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