annotate README_STARV2 @ 4:f7dbe77bbed5 draft

Uploaded
author sarahinraauzeville
date Tue, 12 Dec 2017 10:16:11 -0500
parents aeebcdb9b8b2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
1 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
2 ****** Add perl and xml wrapper files in tools/ d ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
3 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
4
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
5 Download files with hg clone in tools/ directory, then you have these files availables (wrappers and scripts):
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
6 sm_STAR2_V2.pl sm_STAR2_V2.xml
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
7 GalaxyPath.pm
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
8 STAR_indexes.loc.sample
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
9 STAR_indexes.loc.sample
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
10
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
11 Add GalaxyPath.pm file in /path/to/galaxy_sources/ directory
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
12
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
13 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
14 ****** loc file ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
15 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
16
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
17 mv STAR_indexes.loc.sample STAR_indexes.loc
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
18 then
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
19 Add STAR_indexes.loc in yout tool-data/ repository
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
20
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
21 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
22 ****** tool_conf.xml file to update ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
23 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
24
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
25 Add a tag <tool> in your section "RNAseq" (for instance) in your config/tool_conf.xml file:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
26 <tool file="/path/to/sm_STAR2_V2.xml" />
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
27
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
28 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
29 ****** job_conf.xml file to update ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
30 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
31 Add a new section in config/job_conf.xml file, in <destinations> tag, add these lines:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
32
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
33 <destination id="sm_star_single_V2_job" runner="drmaa">
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
34 <param id="galaxy_external_runjob_script">scripts/drmaa_external_runner.py</param>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
35 <param id="galaxy_external_killjob_script">scripts/drmaa_external_killer.py</param>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
36 <param id="galaxy_external_chown_script">scripts/external_chown_script.py</param>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
37 <param id="nativeSpecification">-clear -V -q galaxy.q -l mem=12G -l h_vmem=16G -pe parallel_smp 2</param>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
38 <env file="/galaxydata/galaxy-prod/my_config/local_env.sh"/>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
39 </destination>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
40
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
41 and in <tools> tag:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
42 <tool id="sm_star_single_V2" destination="sm_star_single_V2_job"/>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
43
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
44 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
45 ****** tool_data_table_conf.xml file to update ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
46 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
47
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
48 Add these lines in your tool_data_table_conf.xml file:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
49
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
50 <!-- location of loc file for STAR V2 tool -->
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
51 <table name="STAR_indexes" comment_char="#">
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
52 <columns>value, dbkey, name, path</columns>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
53 <file path="my_tool-data/STAR_indexes.loc" />
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
54 </table>
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
55
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
56 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
57 ****** Add paths in galaxy.ini configuation file ******
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
58 ************************************************************************************
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
59
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
60 Add a my_bin/ directory in galaxy repository with symbolic links to binaries:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
61 $ ls -ltrah /path/to/galaxy/my_bin/STAR*
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
62 lrwxrwxrwx 1 galaxy-prod wbioinfo 11 3 juin 2016 /galaxydata/galaxy-prod/my_bin/STAR -> STAR_2.4.0i
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
63
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
64
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
65 Add paths to binaries and a section [workPath], at the end of galaxy.ini file:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
66 Dans geany ../../config/galaxy.ini &
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
67 [workPath]
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
68 STAR_PATH=/path/to/galaxy/my_bin/STAR
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
69
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
70
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
71 Add a my_workspace/ directory in galaxy repository to run this module in debug mode:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
72 cd /path/to/galaxy/;
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
73 mkdir my_workspace/;
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
74 chmod 777 my_workspace/;
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
75
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
76 Add paths to binaries and a section [workPath], at the end of galaxy.ini file:
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
77 Dans geany ../../config/galaxy.ini &
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
78 [workPath]
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
79 MYWORKSPACE=/path/to/galaxy/my_workspace/
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
80
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
81
aeebcdb9b8b2 Uploaded
sarahinraauzeville
parents:
diff changeset
82