annotate README.org @ 1:5596bafd2119 draft

Uploaded
author petr-novak
date Tue, 12 Dec 2017 04:33:04 -0500
parents dd46956ff61f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
1 #+TITLE: Sequence Read Simulator
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
2 #+AUTHOR: Petr Novak
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
3
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
4 Create pseudo short reads from long reads (Illumina Like).
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
5
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
6 * Requirements
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
7 - python version > 3.4
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
8 - biopython
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
9
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
10 * Available tools
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
11 ** long_reads_sampling
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
12 #+BEGIN_EXAMPLE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
13
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
14 usage: long_reads_sampling.py [-h] [-i INPUT] [-o OUTPUT] [-l TOTAL_LENGTH]
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
15 [-s SEED]
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
16
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
17 Create sample of long reads, instead of setting number of reads to be sampled,
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
18 total length of all sampled sequences is defined
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
19
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
20 optional arguments:
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
21 -h, --help show this help message and exit
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
22 -i INPUT, --input INPUT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
23 file with long reads in fasta format (default: None)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
24 -o OUTPUT, --output OUTPUT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
25 Output file name (default: None)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
26 -l TOTAL_LENGTH, --total_length TOTAL_LENGTH
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
27 total length of sampled output (default: None)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
28 -s SEED, --seed SEED random number generator seed (default: 123)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
29 #+END_EXAMPLE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
30
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
31 ** long2short
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
32 #+BEGIN_EXAMPLE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
33 usage: long2short.py [-h] [-i INPUT] [-o OUTPUT] [-cov COVERAGE]
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
34 [-L INSERT_LENGTH] [-l READ_LENGTH]
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
35
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
36 Creates pseudo short reads from long oxford nanopore reads
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
37
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
38 optional arguments:
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
39 -h, --help show this help message and exit
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
40 -i INPUT, --input INPUT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
41 file with long reads in fasta format (default: None)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
42 -o OUTPUT, --output OUTPUT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
43 Output file name (default: None)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
44 -cov COVERAGE, --coverage COVERAGE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
45 samplig coverage (default: 0.1)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
46 -L INSERT_LENGTH, --insert_length INSERT_LENGTH
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
47 length of insert, must be longer than read length
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
48 (default: 600)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
49 -l READ_LENGTH, --read_length READ_LENGTH
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
50 read length (default: 100)
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
51
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
52 #+END_EXAMPLE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
53 resulting reads in fasta format has names which include following information:
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
54 - original long read name index
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
55 - position of pseudo forward read in long reads
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
56 forward a reverse reads are interlaced a reverse reads are reverse complement of original long sequence
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
57 example outut:
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
58 #+BEGIN_EXAMPLE
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
59 >1_1_101_f
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
60 TGGTACTTGCGGTTACGTATTGCTAGCTAGTCTCCATTTGTCCGTTGGTCTTAGGTGATT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
61 TTCCAAGCTTTGTGTGTAAATGTAAGGATCCTCATTTGTA
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
62 >1_1_101_r
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
63 GTTTTGTTATCGTGATCCACAGATCAGAAGATATCGCCGCTCACCTGTCAATTAATCTTA
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
64 ACTTAATGTACACTAGGGTTTTGGTTTTAACTGCTATCTT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
65 >1_2001_2101_f
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
66 CTGAGTTGGGCAACATAGCCGACAAATTTGAACAATAAGCCGGTCCAGCCTTCTTTCTCA
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
67 GCTGATACATGAAACAAATCAAAGGAGCATTGTAAAGGCG
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
68 >1_2001_2101_r
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
69 TTTTGAATGATGGCACTACCGTGATCAAGGACGATGGTCTCCGTTCACTCGCTTTTGTTG
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
70 TACGTTCTCTATGAACTTGGTTTCTTTGCATTCGGTTCTT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
71 >1_4001_4101_f
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
72 GAAGTTGAAGGAACATTTGGAAAGGTGTGTGAAGACTAATTTGGTCT
dd46956ff61f Uploaded
petr-novak
parents:
diff changeset
73 #+END_EXAMPLE