-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathPKG-INFO
297 lines (217 loc) · 13.3 KB
/
PKG-INFO
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
Name: TEtranscripts
Version: 2.2.3
Summary: Tools for estimating differential enrichment of Transposable Elements and other highly repetitive regions
Home-page: https://www.mghlab.org/software/tetranscripts
Author: Ying Jin, Eric Paniagua, Talitha Forcier, Oliver Tam and Molly Hammell
Author-email: [email protected]
License: GPLv3
Description: TEtranscripts
=========
Version: 2.2.3
TEtranscripts is composed of two tools, TEtranscripts and TEcounts
*NOTE* All programs rely on specially curated GTF files, which are not
packaged with this software due to their size. Please go to
`our website <https://www.mghlab.org/software/tetranscripts>`_
for instructions to download the curated GTF files.
TEtranscripts and TEcount takes RNA-seq (and similar data) and annotates reads
to both genes & transposable elements. TEtranscripts then performs differential
analysis using DESeq2.
`Github Page <https://github.com/mhammell-laboratory/TEtranscripts>`_
`Pypi Page <https://pypi.python.org/pypi/TEToolkit>`_
`MHammell Lab <https://www.mghlab.org/software>`_
Created by Ying Jin, Eric Paniagua, Oliver Tam & Molly Hammell, February 2014
Copyright (C) 2014-2020 Ying Jin, Eric Paniagua, Talitha Forcier, Oliver Tam & Molly Hammell
Contact: [email protected]
Requirements
------------
Python: 2.6.x or 2.7.x or 3.x (tested on Python 2.7.11 and Python 3.7.7)
pysam: 0.9.0 or greater
R: 2.15.x or greater
DESeq2: 1.10.x or greater (recommended)
Installation
------------
1. Download compressed tarball.
2. Unpack tarball.
3. Navigate into unpacked directory.
4. Run the following::
$ python setup.py install
If you want to install locally (e.g. /local/home/usr),
run this command instead::
$ python setup.py install --prefix /local/home/usr
*NOTE* In the above example, you must add
/local/home/usr/bin
to the PATH variable, and
/local/home/usr/lib/python2.X/site-packages
to the PYTHONPATH variable, , where X refers to the
major python version, and Y refers to the minor
python version. (e.g. python2.7 if using python version
2.7.x, and python3.6 if using python version 3.6.x)
TEtranscripts
=============
Usage
-----
::
usage: TEtranscripts -t treatment sample [treatment sample ...]
-c control sample [control sample ...]
--GTF genic-GTF-file
--TE TE-GTF-file
[optional arguments]
Required arguments:
-t | --treatment [treatment sample 1 treatment sample 2...]
Sample files in group 1 (e.g. treatment/mutant), separated by space
-c | --control [control sample 1 control sample 2 ...]
Sample files in group 2 (e.g. control/wildtype), separated by space
--GTF genic-GTF-file GTF file for gene annotations
--TE TE-GTF-file GTF file for transposable element annotations
Optional arguments:
*Input/Output options*
--format [input file format]
Input file format: BAM or SAM. DEFAULT: BAM
--stranded [option] Is this a stranded library? (no, forward, or reverse).
no - Library is unstranded
forward - "Second-strand" cDNA library (e.g. QIAseq stranded)
reverse - "First-strand" cDNA library (e.g. Illumina TruSeq stranded)
DEFAULT: no.
--sortByPos Input file is sorted by chromosome position.
--project [name] Prefix used for output files (e.g. project name)
DEFAULT: TEtranscript_out
*Analysis options*
--mode [TE counting mode]
How to count TE:
uniq (unique mappers only)
multi (distribute among all alignments).
DEFAULT: multi
--minread [min_read] read count cutoff. DEFAULT: 1
-L | --fragmentLength [fragLength]
Average length of fragment used for single-end sequencing
DEFAULT: For paired-end, estimated from the input alignment file. For single-end, ignored by default.
-i | --iteration
maximum number of iterations used to optimize multi-reads assignment. DEFAULT: 100
-p | --padj [pvalue]
FDR cutoff for significance. DEFAULT: 0.05
-f | --foldchange [foldchange]
Fold-change ratio (absolute) cutoff for differential expression.
DEFAULT: 1
*DESeq1 compatability options
--DESeq
Use DESeq (instead of DESeq2) for differential analysis.
-n | --norm [normalization]
Normalization method : DESeq_default (default normalization method of DESeq), TC (total annotated read counts), quant (quantile normalization). Only applicable if DESeq is used instead of DESeq2.
DEFAULT: DESeq_default
*Other options*
-h | --help
Show help message
--verbose [number]
Set verbose level.
0: only show critical messages
1: show additional warning messages
2: show process information
3: show debug messages
DEFAULT: 2
--version
Show program's version and exit
*NOTE* BAM files must be either unsorted or sorted by queryname. If the BAM files are sorted by position, please use the '--sortByPos' option
Example Command Lines
---------------------
If BAM files are unsorted, or sorted by queryname::
TEtranscripts --format BAM --mode multi -t RNAseq1.bam RNAseq2.bam -c CtlRNAseq1.bam CtlRNAseq.bam --project sample_nosort_test
If BAM files are sorted by coordinates/position::
TEtranscripts --sortByPos --format BAM --mode multi -t RNAseq1.bam RNAseq2.bam -c CtlRNAseq1.bam CtlRNAseq.bam --project sample_sorted_test
TEcount
=============
Usage
-----
::
usage: TEcount -b RNAseq BAM
--GTF genic-GTF-file
--TE TE-GTF-file
[optional arguments]
Required arguments:
-b | --BAM alignment-file RNAseq alignment file (BAM preferred)
--GTF genic-GTF-file GTF file for gene annotations
--TE TE-GTF-file GTF file for transposable element annotations
Optional arguments:
*Input/Output options*
--format [input file format]
Input file format: BAM or SAM. DEFAULT: BAM
--stranded [option] Is this a stranded library? (no, forward or reverse).
no - Library is unstranded
forward - "Second-strand" cDNA library (e.g. QIAseq stranded)
reverse - "First-strand" cDNA library (e.g. Illumina TruSeq stranded)
DEFAULT: no.
--sortByPos Input file is sorted by chromosome position.
--project [name] Prefix used for output files (e.g. project name)
DEFAULT: TEcount_out
*Analysis options*
--mode [TE counting mode]
How to count TE:
uniq (unique mappers only)
multi (distribute among all alignments).
DEFAULT: multi
-L | --fragmentLength [fragLength]
Average length of fragment used for single-end sequencing
DEFAULT: For paired-end, estimated from the input alignment file. For single-end, ignored by default.
-i | --iteration
maximum number of iterations used to optimize multi-reads assignment. DEFAULT: 100
*Other options*
-h | --help
Show help message
--verbose [number]
Set verbose level.
0: only show critical messages
1: show additional warning messages
2: show process information
3: show debug messages
DEFAULT: 2
--version
Show program's version and exit
*NOTE* BAM files must be either unsorted or sorted by queryname. If the BAM files are sorted by position, please use the '--sortByPos' option
Example Command Lines
---------------------
If BAM files are unsorted, or sorted by queryname::
TEcount --format BAM --mode multi -b RNAseq.bam --project sample_nosort_test
If BAM files are sorted by coordinates/position::
TEtranscripts --sortByPos --format BAM --mode multi -b RNAseq.bam --project sample_sorted_test
Recommendations for TEtranscripts input files
=========================================
TEtranscripts can perform transposable element quantification from alignment results (e.g. BAM files) generated from a variety of programs.
Given the variety of experimental systems, we could not provide an optimal alignment strategy for every approach. Therefore,
we recommend that users identify the optimal parameters for their particular genome and alignment program in order to get the best
results.
When optimizing the alignment parameters, we recommend taking these points into consideration:
*Allowing sufficient number of multi-mappers during alignment*
Most alignment programs provide only 1 alignment per read by default. We recommend reporting multiple alignments per read. We have found
that reporting a maximum of 100 alignments per read provides an optimal compromise between the size of the alignment file and recovery
of multi-mappers in many genome builds. However, we highly suggest that users optimize this parameter for their particular experiment,
as this could significantly improve the quality of transposable element quantification.
*Optimizing alignment parameters for non-reference strains*
It is common that the specific laboratory strains used in an experiment contains genomic variations not present in the reference strain.
While this can be mitigated through allowing mismatches during alignments, certain lab strains (e.g. Drosophila melanogaster) have
diverged significantly from the reference genomes. We highly recommend that users should refine their alignment procedures to better
account for the expected variations between their lab strains and the reference genome, which will accordingly improve their analysis
with TEtranscripts. Users can also align to a custom genome build specific to their organism, though they would need GTF annotations for
genes and transposable elements that are compatible with their custom genome in order to utilize TEtranscripts. Please contact us if you
require advice in generating these annotation files.
*Specific recommendations when using STAR*
`STAR <https://github.com/alexdobin/STAR>`_ utilizes two parameters for optimal identification of multi-mappers `--outFilterMultimapNmax` and `--outAnchorMultimapNmax`.
The author of STAR recommends that `--outAnchorMultimapNmax` should be set at twice the value used in `--outFilterMultimapNmax`,
but no less than 50. In our study, we used the same number for both parameters (100), and found negligible differences in identifying
multi-mappers. Upon further discussion with the author of STAR, we recommend that setting the same value for `--outAnchorMultimapNmax`
and `--outFilterMultimapNmax`, though we highly suggest users test multiple values of `--outAnchorMultimapNmax` to identify the
optimal value for their experiment.
Copying & distribution
======================
TEtranscripts and TEcount are part of `TEToolkit suite <https://www.mghlab.org/software/>`_.
TEtranscripts is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but *WITHOUT ANY WARRANTY*; without even the implied warranty of
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE*. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with TEtranscripts. If not, see `this website <http://www.gnu.org/licenses/>`_.
Keywords: TE transposable element differential enrichment
Platform: Linux
Platform: MacOSX