annotate README @ 8:d4f9b7beb52f

cleaning the repository - GUI make it hard
author vipints <vipin@cbio.mskcc.org>
date Thu, 23 Apr 2015 17:51:14 -0400
parents 6e589f267c14
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
6e589f267c14 Uploaded
devteam
parents:
diff changeset
1 A collection of tools for converting genome annotation between GTF (Gene Transfer Format),
6e589f267c14 Uploaded
devteam
parents:
diff changeset
2 BED (Browser Extensible Data) and GFF (Generic Feature Format).
6e589f267c14 Uploaded
devteam
parents:
diff changeset
3
6e589f267c14 Uploaded
devteam
parents:
diff changeset
4 INTRODUCTION
6e589f267c14 Uploaded
devteam
parents:
diff changeset
5
6e589f267c14 Uploaded
devteam
parents:
diff changeset
6 Several genome annotation centers provide their data in GTF, BED, GFF3 etc. I have few programs
6e589f267c14 Uploaded
devteam
parents:
diff changeset
7 they mainly deals with converting between GTF, BED and GFF3 formats. They are extensively tested
6e589f267c14 Uploaded
devteam
parents:
diff changeset
8 with files from different centers like ENSEMBL, UCSC, JGI and NCBI AceView. Please follow the
6e589f267c14 Uploaded
devteam
parents:
diff changeset
9 instructions below to clone these tools into your galaxy instance.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
10
6e589f267c14 Uploaded
devteam
parents:
diff changeset
11 CONTENTS
6e589f267c14 Uploaded
devteam
parents:
diff changeset
12
6e589f267c14 Uploaded
devteam
parents:
diff changeset
13 Tool configuration files in *.xml format.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
14
6e589f267c14 Uploaded
devteam
parents:
diff changeset
15 gtf_to_gff.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
16 gff_to_gtf.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
17 bed_to_gff.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
18 gff_to_bed.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
19 gbk_to_gff.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
20 gff_fmap.xml
6e589f267c14 Uploaded
devteam
parents:
diff changeset
21
6e589f267c14 Uploaded
devteam
parents:
diff changeset
22 Python based scripts.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
23
6e589f267c14 Uploaded
devteam
parents:
diff changeset
24 gtf_to_gff.py: convert data from GTF to valid GFF3.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
25 gff_to_gtf.py: convert data from GFF3 to GTF.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
26 bed_to_gff.py: convert data from a 12 column UCSC wiggle BED format to GFF3.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
27 gff_to_bed.py: convert gene transcript annotation from GFF3 to UCSC wiggle 12 column BED format.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
28 gbk_to_gff.py: convert data from genbank format to GFF.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
29 gff_fmap.py: find the relation between different features described in a GFF file.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
30 GFFParser.py: Parse GFF/GTF files.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
31 helper.py: Utility functions.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
32
6e589f267c14 Uploaded
devteam
parents:
diff changeset
33 test-data: Test data set. (move to your galaxy_root_folder/test-data/)
6e589f267c14 Uploaded
devteam
parents:
diff changeset
34
6e589f267c14 Uploaded
devteam
parents:
diff changeset
35 You may need to move the test files into your test-data directory so galaxy can find them.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
36 If you want to run the functional tests eg as:
6e589f267c14 Uploaded
devteam
parents:
diff changeset
37
6e589f267c14 Uploaded
devteam
parents:
diff changeset
38 exmaple:
6e589f267c14 Uploaded
devteam
parents:
diff changeset
39 sh run_functional_tests.sh -id fml_gtf2gff
6e589f267c14 Uploaded
devteam
parents:
diff changeset
40
6e589f267c14 Uploaded
devteam
parents:
diff changeset
41 REQUIREMENTS
6e589f267c14 Uploaded
devteam
parents:
diff changeset
42
6e589f267c14 Uploaded
devteam
parents:
diff changeset
43 python
6e589f267c14 Uploaded
devteam
parents:
diff changeset
44
6e589f267c14 Uploaded
devteam
parents:
diff changeset
45 COMMENTS/QUESTIONS
6e589f267c14 Uploaded
devteam
parents:
diff changeset
46
6e589f267c14 Uploaded
devteam
parents:
diff changeset
47 I can be reached at vipin [at] cbio.mskcc.org
6e589f267c14 Uploaded
devteam
parents:
diff changeset
48
6e589f267c14 Uploaded
devteam
parents:
diff changeset
49 LICENSE
6e589f267c14 Uploaded
devteam
parents:
diff changeset
50
6e589f267c14 Uploaded
devteam
parents:
diff changeset
51 Copyright (C) 2009-2012 Friedrich Miescher Laboratory of the Max Planck Society
6e589f267c14 Uploaded
devteam
parents:
diff changeset
52 2013-2014 Memorial Sloan Kettering Cancer Center
6e589f267c14 Uploaded
devteam
parents:
diff changeset
53
6e589f267c14 Uploaded
devteam
parents:
diff changeset
54 This program is free software; you can redistribute it and/or modify
6e589f267c14 Uploaded
devteam
parents:
diff changeset
55 it under the terms of the GNU General Public License as published by
6e589f267c14 Uploaded
devteam
parents:
diff changeset
56 the Free Software Foundation; either version 3 of the License, or
6e589f267c14 Uploaded
devteam
parents:
diff changeset
57 (at your option) any later version.
6e589f267c14 Uploaded
devteam
parents:
diff changeset
58
6e589f267c14 Uploaded
devteam
parents:
diff changeset
59 COURTESY
6e589f267c14 Uploaded
devteam
parents:
diff changeset
60
6e589f267c14 Uploaded
devteam
parents:
diff changeset
61 To the Galaxy Team.