annotate seqsero.xml @ 8:b04931a9fe71 draft

planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
author charles_s_test
date Tue, 28 Nov 2017 18:55:00 -0500
parents 38ad1130d077
children acc5cd06a36a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
1 <tool id="seq_sero_reads_multiple" name="SeqSero Batch - Paired-End Reads" version="0.1.0">
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
2 <description>Salmonella Serotype Prediction from Paired-End Reads</description>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
3 <requirements>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
4 <requirement type="package" version="1.67">biopython</requirement>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
5 <requirement type="package" version="1.6" >samtools</requirement>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
6 <requirement type="package" version="0.7.17" >bwa</requirement>
2
0d65b71ff8df planemo upload commit 464b391afaa5819bc681452e85bea9d882730eb6
charles_s_test
parents: 0
diff changeset
7 <requirement type="package" version="2.5.0">blast</requirement>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
8 <requirement type="package" version="2.8.1">sra-tools</requirement>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
9 </requirements>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
10
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
11 <stdio>
2
0d65b71ff8df planemo upload commit 464b391afaa5819bc681452e85bea9d882730eb6
charles_s_test
parents: 0
diff changeset
12 <exit_code range="0:" level="warning"/>
0d65b71ff8df planemo upload commit 464b391afaa5819bc681452e85bea9d882730eb6
charles_s_test
parents: 0
diff changeset
13 <regex match="Error:"/>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
14 </stdio>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
15 <!-- <command interpreter="python2.7">
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
16 run_seqsero.py $input1
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
17 run_seqsero_batch_galaxy.py $input1 $input2-->
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
18 <!--test_bioblend.py $input1 $input2
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
19 </command> -->
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
20 <command >
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
21
8
b04931a9fe71 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 3
diff changeset
22 python $__tool_directory__/run_seqsero.py $input1 $__tool_directory__/
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
23
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
24 </command>
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
25 <inputs>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
26 <param format="fastq,fastqsanger" name="input1" multiple="true" type="data" label="Source file"/>
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
27 <!--<param format="fastq" name="input2" multiple="true" type="data" label="Source file"/>-->
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
28 </inputs>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
29 <outputs>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
30 <data name="html_file" format="html" from_work_dir="Seqsero_result.html"/>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
31 <data name="text_file" format="txt" from_work_dir="Seqsero_result.txt"/>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
32 </outputs>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
33 <tests>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
34 <test>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
35 <output name="text_txt" file="Seqsero_result.txt"/>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
36 </test>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
37 </tests>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
38 <help>
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
39 **This tool predicts Salmonella serotypes from shotgun WGS data.**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
40
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
41
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
42 **SeqSero Documentation**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
43
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
44 **Log in:**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
45  A username and password should have been emailed to you – change your password after logging in the first time.
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
46
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
47 **Creating and naming a history (histories in Galaxy are what datasets are associated with):**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
48  Click on the cog in the upper right corner and choose “create new” from the dropdown menu. To name your history, click on the current name (“unnamed history”) type a new name and hit return.
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
49
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
50 **Uploading data:**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
51  Click on the disk with the up arrow in the upper left region. Click on choose local file and navigate to the file. Select the paired end read files to be used and click open. Alternatively, files can be dragged into the box. After the files of interest have been selected click start to upload them to the Galaxy server.
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
52
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
53 **Running SeqSero:**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
54  In the left pane, click on “FDA tools” then “SeqSero Batch – Paired-End Reads.” Select the pairs of sequencing runs of interest and click on “Execute” in the main pane.
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
55
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
56 **Share a dataset:**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
57  Make sure your current library contains the data you want to share. Click on “Shared Data” from the top. Then choose “Data Libraries” from the dropdown. If you want the data to have its own folder, click on “+ new library” and give it a name. Choose the library to which you want to add the data and click on “+ data (page icon)”. Select the datasets you want to share and click “Add”. Or click on the cog in the upper right and select copy datasets from the dropdown.
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
58
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
59 **Import dataset into current history:**
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
60  Go to “Shared Data” → “Data Libraries”. Select the relevant library and select the data of interest. Click on “to History”. Select the correct history from the dropdown and click import.
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
61
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
62 </help>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
63
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
64 <citations>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
65 <citation type="bibtex">
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
66 @Article{pmid25762776,
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
67 Author="Zhang, S. and Yin, Y. and Jones, M. B. and Zhang, Z. and Deatherage Kaiser, B. L. and Dinsmore, B. A. and Fitzgerald, C. and Fields, P. I. and Deng, X. ",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
68 Title="{{S}almonella serotype determination utilizing high-throughput genome sequencing data}",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
69 Journal="J. Clin. Microbiol.",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
70 Year="2015",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
71 Volume="53",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
72 Number="5",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
73 Pages="1685--1692",
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
74 Month="May"
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
75 }
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
76 </citation>
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
77 </citations>
3
38ad1130d077 planemo upload commit a4fb57231f274270afbfebd47f67df05babffa4a-dirty
charles_s_test
parents: 2
diff changeset
78
0
6895de35a263 planemo upload commit 844a891e4eaf732830043204ac636907eefb011d-dirty
charles_s_test
parents:
diff changeset
79 </tool>