annotate TEisotools-1.0/TEiso/doc/README_TEiso.txt @ 6:20ec0d14798e draft

Uploaded
author urgi-team
date Wed, 20 Jul 2016 05:00:24 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
1 ==============================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
2 README for TEiso
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
3 ==============================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
4 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
5 ======================= dependencies =======================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
6 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
7
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
8 Bowtie, Tophat, Cufflinks, Cuffcompare, Bedtools_closest.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
9
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
10 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
11 ===================== INSTALLATION =========================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
12 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
13
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
14 $tar -xzf TEiso-1.2.tar.gz
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
15 $cd TEiso-1.2/
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
16 $python setup_TEiso.py install
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
17 $export PYTHONPATH=$PWD
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
18 $export PATH=$PATH:$PWD/bin
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
19
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
20
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
21
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
22 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
23 ======================== description =======================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
24 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
25
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
26 TEiso is a python script that allows to find distance between the element transposable and TSS of isoforms :
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
27
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
28
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
29 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
30 ===================== command examples =====================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
31 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
32 if reads are single:
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
33 LaunchTEiso.py -f <genome.fa> -g <transcripts.gtf> -e single -s <single_read> -t <TE.gff> -a cufflinks
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
34 if reads are paired:
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
35 LaunchTEiso.py -f <genome.fa> -g <transcripts.gtf> -e paired -l <reads_left> -r <reads_right> -t <TE.gff> -a cufflinks
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
36
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
37 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
38 ========================== options =========================
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
39 ------------------------------------------------------------
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
40
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
41 --version show program's version number and exit
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
42 -h, --help show this help message and exit
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
43
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
44 -f INPUT_REFERENCE, --input_reference=INPUT_REFERENCE
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
45 file with ref sequences
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
46
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
47 -g INPUT_TRANSCRIPTS, --input_transcripts=INPUT_TRANSCRIPTS
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
48 GTF/GFF with known transcripts
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
49
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
50 -e SINGLE_PAIRED, --single_paired=SINGLE_PAIRED
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
51 type of input reads, single or paired end
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
52
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
53 -s SINGLE_READ, --single_read=SINGLE_READ
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
54 a single input read
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
55
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
56 -l LEFT_READ, --left_read=LEFT_READ
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
57 left reads
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
58
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
59 -r RIGTH_READ, --rigth_read=RIGTH_READ
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
60 right reads
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
61
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
62 -t INPUT_TRANSPOSABLE_ELEMENT, --input_transposable_element=INPUT_TRANSPOSABLE_ELEMENT
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
63 GFF with known transposable_element
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
64
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
65 -a ASSEMBLY_TOOL, --assembly_tool=ASSEMBLY_TOOL
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
66 type of RNA-Seq assembly tool
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
67
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
68 -