annotate gca.xml @ 4:e426a7a39562 default tip

Set version on Conservation Plot tool
author Jim Johnson <jj@umn.edu>
date Wed, 17 Dec 2014 15:11:38 -0600
parents 4e52505adaa6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
1 <tool name="GCA: Gene centered annotation" id="ceas_gca" version="0.1.0">
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
2 <description>Find the nearest interval in the given intervals set fo every annotated coding gene</description>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
3 <macros>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
4 <import>ceas_macros.xml</import>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
5 </macros>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
6 <expand macro="requirements" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
7 <command>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
8 gca -b $bfile --span=$span
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
9 #include source=$gtpath_ceasdb_ref#
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
10 --name=$name &amp;> $log
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
11 </command>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
12 <inputs>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
13 <param name="name" type="hidden" value="gca_out"/>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
14 <param ftype="bed" format="bed" name="bfile" type="data" label="BED file(100,000 lines max)">
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
15 <validator type="unspecified_build" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
16 </param>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
17 <expand macro="ceasdb_ref" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
18 <param name="span" type="text" label="Span" value="3000">
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
19 <validator type="in_range" max="1000000" min="100" message="Span is out of range, Span has to be between 100 to 1000000" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
20 </param>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
21 </inputs>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
22 <outputs>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
23 <data format="xls" name="output" from_work_dir="gca_out.xls"/>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
24 <data format="txt" name="log" label="GCA job log"/>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
25 </outputs>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
26 <expand macro="stdio" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
27 <tests>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
28 <test maxseconds="3600" name="GCA_1">
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
29 <param name="bfile" value="peaks.bed" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
30 <param name="span" value="3000" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
31 <param name="refsrc" value="history"/>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
32 <param name="gdb" ftype="ceasdb" value="mm9.refGene.ceasdb"/>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
33 <output name="output">
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
34 <assert_contents>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
35 <has_text_matching expression="NM_013495\tchr19\t3323300\t3385733\t+\t2994\t754\t31798\t224353\t0.07\t0.26\t0.12\t0.03\t0.0\t0.0\t0.0" />
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
36 </assert_contents>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
37 </output>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
38 </test>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
39 </tests>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
40 <help>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
41 This tool finds the nearest binding sites in the given BED file for
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
42 every annotated coding gene. It's a module in CEAS package which is
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
43 written by Hyunjin Gene Shin, published in Bioinformatics (pubmed
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
44 id:19689956).
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
45
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
46 @EXTERNAL_DOCUMENTATION@
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
47
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
48 @CITATION_SECTION@
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
49
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
50 .. class:: warningmark
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
51
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
52 **NEED IMPROVEMENT**
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
53
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
54 -----
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
55
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
56 **Parameters**
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
57
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
58 - **BED file** contains the transcription factor binding sites,
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
59 generally the BED files for peaks from peak calling tools.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
60 - **Span** is the span for ChIP regions.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
61 - **Genome Annotation Version** to specify the annotations according to
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
62 the data set. The annotations are downloaded from UCSC genome site.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
63
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
64 -----
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
65
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
66 **Output**
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
67
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
68 - **XLS file** is the tab-delimited file.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
69
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
70 -----
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
71
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
72 **script parameter list of GCA**
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
73
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
74 Options:
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
75 --version show program's version number and exit
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
76 -h, --help Show this help message and exit.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
77 -b BED, --bed=BED BED file of ChIP regions.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
78 -g GDB, --gt=GDB Gene annotation table. This can be a sqlite3 local db
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
79 file, BED file or genome version of UCSC. The BED file
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
80 must have an extension of '.bed'
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
81 --span=SPAN Span in search of ChIP regions from TSS and TTS,
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
82 DEFAULT=3000bp
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
83 --name=NAME Experiment name. This will be used to name the output
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
84 file. If an experiment name is not given, input BED
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
85 file name will be used instead.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
86 --gn-group=GN_GROUP A particular group of genes of interest. If a txt file
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
87 with one column of gene names (eg RefSeq IDs in case of
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
88 using a refGene table) is given, gca returns the gene-
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
89 centered annotation of this particular gene group.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
90 --gname2=NAME2 The gene names of --gn-group will be regarded as
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
91 'name2.' See the schema of the gene annotation table.
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
92
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
93 </help>
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
94
4e52505adaa6 Imported from capsule None
jjohnson
parents:
diff changeset
95 </tool>