annotate import_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
4
dd15479a0863 Uploaded
david-hoover
parents: 2
diff changeset
1 <?xml version="1.0"?>
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
2 <tool id="import_local_file" name="Import local file" version="1.2.0">
1
c583eb302c7a Uploaded
david-hoover
parents: 0
diff changeset
3 <description>from a local filesystem</description>
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
4 <command interpreter="sh">import_local_file.sh '$filepath' $output $userEmail</command>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
5 <inputs>
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
6 <param name="filepath" type="text" size="100" label="Absolute file path" value="/home/foo/blah">
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
7 <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
8 </param>
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
9
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 import: $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 upload a single file that is locally available on Helix or Biowulf. There is no browse function,
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
21 however, so you will need to give the full path name. If you have permission to read the file, Galaxy can import the file.
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
22
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
23 .. class:: warningmark
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
24
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
25 **Important Notes**
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
26
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
27 - The file path must be a file, not a directory
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
28 - You must give the fullpath to the file (/home/user/myfile.txt, not ./myfile.txt)
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
29 - You must have permission to read the file
8
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
30 - Only /home or /data directories are allowed
01687750c862 Uploaded
david-hoover
parents: 7
diff changeset
31 - The files must be on Helix or Biowulf! Use 'Upload File' for all other files!
0
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
32
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
33 -----
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
34
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
35 **Example**
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
36
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
37 - /home/user/bamfiles/abc123.bam
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
38 - /data/anotheruser/data/good_data/very_good_data.txt
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
39
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
40 </help>
c772c8912663 Uploaded
david-hoover
parents:
diff changeset
41 </tool>