annotate README @ 6:3be0e0a858fe

refactor and update README
author Jim Johnson <jj@umn.edu>
date Tue, 08 Nov 2011 13:22:34 -0600
parents
children 7f032685214b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
1 GMAP applications and citation info are available from: http://research-pub.gene.com/gmap/
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
2
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
3
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
4 Installation instructions are in the README file in the download,
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5 and online: http://research-pub.gene.com/gmap/src/README
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
7 These tools were consistent with gmap version: 2011-10-16
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
8
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
9
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 GMAP and GSNAP use added datatypes:
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
11
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 add datatype definition file: lib/galaxy/datatypes/gmap.py
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 add the following import line to: lib/galaxy/datatypes/registry.py
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
15 import gmap # added for gmap tools
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
16
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
17 add to datatypes_conf.xml
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18 <!-- Start GMAP Datatypes -->
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 <datatype extension="gmapdb" type="galaxy.datatypes.gmap:GmapDB" display_in_upload="False"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 <datatype extension="gmapsnpindex" type="galaxy.datatypes.gmap:GmapSnpIndex" display_in_upload="False"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21 <datatype extension="iit" type="galaxy.datatypes.gmap:IntervalIndexTree" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 <datatype extension="splicesites.iit" type="galaxy.datatypes.gmap:SpliceSitesIntervalIndexTree" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 <datatype extension="introns.iit" type="galaxy.datatypes.gmap:IntronsIntervalIndexTree" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
24 <datatype extension="snps.iit" type="galaxy.datatypes.gmap:SNPsIntervalIndexTree" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
25 <datatype extension="tally.iit" type="galaxy.datatypes.gmap:TallyIntervalIndexTree" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 <datatype extension="gmap_annotation" type="galaxy.datatypes.gmap:IntervalAnnotation" display_in_upload="False"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 <datatype extension="gmap_splicesites" type="galaxy.datatypes.gmap:SpliceSiteAnnotation" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 <datatype extension="gmap_introns" type="galaxy.datatypes.gmap:IntronAnnotation" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 <datatype extension="gmap_snps" type="galaxy.datatypes.gmap:SNPAnnotation" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
30 <datatype extension="gsnap_tally" type="galaxy.datatypes.gmap:TallyAnnotation" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
31 <datatype extension="gsnap" type="galaxy.datatypes.gmap:GsnapResult" display_in_upload="True"/>
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32 <!-- End GMAP Datatypes -->
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 Tools:
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35 GMAP_Build - create a GmapDB set of index files for a reference sequence and optional set of annotations
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36 GMAP - map sequences to a reference sequence GmapDB index
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 GSNAP - align sequences to a reference and detect splicing
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
39 Add to tool_conf.xml ( probably in the "NGS: Mapping" section )
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
40 <tool file="gmap/gmap.xml" />
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41 <tool file="gmap/gsnap.xml" />
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
42 <tool file="gmap/gmap_build.xml" />
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43 <tool file="gmap/snpindex.xml" />
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
44 <tool file="gmap/iit_store.xml" />
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
45
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
46 Admin built cached gmapdb indexes defined in tool-data/gmap_indices.loc
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
47
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
48
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
49 TODO:
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
51
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
52 Add classes to gmap.py
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
53 CmetIndex - an index created by cmetindex
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
54 AtoiIndex - an index created by atoiindex
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
55
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56 Add tally creation
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
57 gsnap default output -> gsnap_tally -> iit_store
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
58
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
59 Add goby support
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
60 Should add separate tools and datatypes for goby
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
61 GSNAP goby output relies on goby input, might be better to have a separate gsnap tool for goby
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
62
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
63 Possibly add Tools:
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
64 get_genome - retrieves from a gmapdb
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
65 cmetindex - create methylcytosine index
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
66 atoiindex - create A-to-I RNA editing index
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
67
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
68
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
69
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
70
3be0e0a858fe refactor and update README
Jim Johnson <jj@umn.edu>
parents:
diff changeset
71