aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3c497531826dd6eb03e34d0e155e7459217b2601 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
SelectiveGenomeAmplification
============================

PI: http://brisson.bio.upenn.edu/

To use this you'll need:

 - A unix environment
 - kmer_total_count, a kmer counter available here: http://github.com/mutantturkey/dna-utils/
 - bash or compliant shell.
 
 
Setup:

    git clone git@github.com:mutantturkey/SelectiveGenomeAmplification.gi
    cd SelectiveGenomeAmplification
    make
    sudo make install

Example Usage:

    selectiveGenomeAmplification PfalciparumGenome.fasta HumanGenome.fasta;
    less PfalciparumGenome_HumanGenome/final_mers

For user customizable variables:

    max_mer_distance=5000; max_select=6 min_mer_range=6 max_mer_range=12 \
    SelectiveGenomeAmplification.sh PfalciparumGenome.fasta half.fasta 

## Customizable variables

range of mers, min and max 

C | variable | default | notes
:---- | :---- | :---- | ---- | :----
Y | min_mer_range | 6  | minimum mer size to use
Y | max_mer_range | 10 | maximum mer size to use 
Y | max_mer_distance | 5000 | maximum distance between mers in foreground
N | output_directory | $PWD/$foreground_$background/ | ex. if fg is Bacillus.fasta and  bg is HumanGenome.fasta then folder would be $PWD/Bacillus.fasta_HumanGenome_output.fasta/
Y | counts_directory | $output_directory/.tmp | directory for counts directory
Y | tmp_directory=$output_directory/.tmp | temporary files directory
Y | max_melting_temp | 30° | maximum melting temp of mers
Y | min_melting_temp | 0° | minimum melting temp of mers
Y | min_mer_count | Not Enabled (0) | only select mers that occur more frequently than this number
Y | max_select | maximum number of mers to pick
Y | ignore_mers | Not Enabled | mers to explicitly ignore, space seperated ex. ignore_mers="ACAGTA ACCATAA ATATATAT"
Y | foreground | path of foreground file
Y | background | path of background file