annotate export_local_file.xml @ 9:8d6bf2bd8932 draft default tip

Uploaded
author david-hoover
date Tue, 13 May 2014 15:25:51 -0400
parents 01687750c862
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
65598330eb1a Uploaded
david-hoover
parents: 3
diff changeset
1 <?xml version="1.0"?>
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
2 <tool id="export_local_file" name="Export dataset" version="1.2.0">
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
3 <description>to a local filesytem</description>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
4 <command interpreter="sh">export_local_file.sh $input '$filepath' $userEmail $output</command>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
5 <inputs>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
6 <param name="input" type="data" label="Dataset"/>
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
7 <param name="filepath" type="text" size="100" label="Absolute file path" value="/home/foo/blah">
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
8 <validator type="expression" message="The path must begin with either /home or /data">value.lower()[0:5] == '/home' or value.lower()[0:5] == '/data'</validator>
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
9 </param>
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
10 </inputs>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
11 <outputs>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
12 <data format="txt" name="output" label="local export: $filepath" />
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
13 </outputs>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
14 <help>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
15
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
16 .. class:: infomark
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
17
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
18 **Copying files**
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
19
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
20 This tool will allow you to export a single file from Galaxy to a local filesystem on Helix or Biowulf.
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
21 You must have permission to write the file to the given directory, and the file must not yet exist. This tool will
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
22 not overwrite a pre-existing file.
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
23
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
24 .. class:: warningmark
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
25
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
26 **Important Notes**
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
27
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
28 - The file path must be a file, not a directory
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
29 - You must give the fullpath to the file (/home/user/myfile.txt, not ./myfile.txt)
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
30 - You must have permission to write the file in the given directory
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
31 - Only /home or /data directories are allowed.
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
32 - The directories must exist on Helix or Biowulf!
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
33
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
34 -----
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
35
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
36 **Example**
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
37
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
38 - /home/user/bamfiles/abc123.bam
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
39 - /data/anotheruser/data/good_data/very_good_data.txt
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
40
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
41 </help>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
42 </tool>