annotate simple_tool.xml @ 0:f71a1cb1a0d2 draft

Uploaded
author david-hoover
date Wed, 18 Jun 2014 17:00:16 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
1 <?xml version="1.0"?>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
2 <tool id="simple_tool" name="Simple Tool" version="1.0.0">
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
3 <description>Simple Tool</description>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
4 <requirements>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
5 <requirement type="set_environment">SCRIPT_PATH</requirement>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
6 </requirements>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
7 <command interpreter="sh">simple_tool.sh '$filepath' $output</command>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
8 <inputs>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
9 <param name="filepath" type="text" size="100" label="anything" value="/home/foo/blah">
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
10 </param>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
11
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
12 </inputs>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
13 <outputs>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
14 <data format="txt" name="output" label="whatever" />
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
15 </outputs>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
16 <help>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
17
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
18 .. class:: infomark
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
19
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
20 **Copying files**
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
21
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
22 This tool will allow you to upload a single file that is locally available on Helix or Biowulf. There is no browse function,
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
23 however, so you will need to give the full path name. If you have permission to read the file, Galaxy can import the file.
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
24
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
25 .. class:: warningmark
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
26
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
27 **Important Notes**
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
28
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
29 - The file path must be a file, not a directory
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
30 - You must give the fullpath to the file (/home/user/myfile.txt, not ./myfile.txt)
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
31 - You must have permission to read the file
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
32 - Only /home or /data directories are allowed
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
33 - The files must be on Helix or Biowulf! Use 'Upload File' for all other files!
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
34
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
35 -----
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
36
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
37 **Example**
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
38
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
39 - /home/user/bamfiles/abc123.bam
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
40 - /data/anotheruser/data/good_data/very_good_data.txt
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
41
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
42 </help>
f71a1cb1a0d2 Uploaded
david-hoover
parents:
diff changeset
43 </tool>