annotate cami_amber_add_length.xml @ 5:320fef60c541 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 430cd92e7151f4ff87796589e7f51e4007aca38f
author iuc
date Mon, 10 Feb 2025 15:06:39 +0000
parents 22385c4e11a9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
1 <tool id="cami_amber_add" name="CAMI AMBER add length column" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
2 <description>Create gold standard file for CAMI AMBER</description>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
3 <macros>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
4 <import>macros.xml</import>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
5 </macros>
5
320fef60c541 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 430cd92e7151f4ff87796589e7f51e4007aca38f
iuc
parents: 0
diff changeset
6 <expand macro="xrefs"/>
0
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
7 <expand macro="requirements" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
8 <command detect_errors="exit_code">
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
9 <![CDATA[
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
10
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
11 ln -s '${gold_standard_file}' '$gold_standard_file.element_identifier' &&
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
12 ln -s '${fasta_file}' '$fasta_file.element_identifier' &&
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
13
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
14 add_length_column.py
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
15 -g '$gold_standard_file.element_identifier'
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
16 -f '$fasta_file.element_identifier'
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
17 > gold_standard_file.tsv
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
18 ]]>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
19 </command>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
20 <inputs>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
21 <param argument="--gold_standard_file" type="data" format="tabular"
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
22 label="Input gold standard file here"
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
23 help="Input a binning file in biobox format to generate a biobox format file with the extra column 'Length' which is needed for AMBER. Every other biobox format can be used for this as well!" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
24 <param argument="--fasta_file" type="data" format="fasta,fasta.gz,fastq,fastq.gz"
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
25 label="Input fasta/fastq file here"
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
26 help="Input the file which match to the gold standard file" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
27 </inputs>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
28 <outputs>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
29 <data name="file" format="tabular" from_work_dir="gold_standard_file.tsv" label="${tool.name}: Gold standard file" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
30 </outputs>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
31 <tests>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
32 <test expect_num_outputs="1">
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
33 <param name="gold_standard_file" value="test_add.tsv" ftype="tabular" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
34 <param name="fasta_file" value="test_add.fasta.gz" ftype="fasta.gz" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
35 <output name="file" >
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
36 <assert_contents>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
37 <has_size value="124000" delta="3000" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
38 </assert_contents>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
39 </output>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
40 </test>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
41 </tests>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
42 <help>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
43 <![CDATA[
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
44 .. class:: infomark
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
45
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
46 **What it does**
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
47
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
48 This tool can create the gold standard file which has to be used for the CAMI AMBER.
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
49
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
50 **Input**
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
51
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
52 This tool required 2 inputs:
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
53
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
54 - A binning file (biobox format)
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
55
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
56 This file can be created via the convert_to_biobox tool
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
57
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
58 .. class:: infomark
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
59
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
60 Example(tab separated):
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
61
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
62 ::
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
63
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
64 #CAMI Format for Binning
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
65 @Version:0.9.0
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
66 @SampleID:CAMI_low
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
67 @@SEQUENCEID BINID
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
68 RL|S1|C10 Bin_034
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
69 RL|S1|C100 Bin_023
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
70 RL|S1|C1000 Bin_034
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
71 RL|S1|C10000 Bin_019
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
72 RL|S1|C10002 Bin_035
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
73 RL|S1|C10004 Bin_035
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
74 RL|S1|C10008 Bin_034
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
75 RL|S1|C10011 Bin_035
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
76 RL|S1|C10012 Bin_013
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
77 RL|S1|C10014 Bin_035
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
78
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
79 - A fasta/fastq file (fasta,fasta.gz,fastq,fastq.gz format)
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
80
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
81 This file need the identical sequences which are in the gold standard file to create the finish gold standard file for CAMI AMBER
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
82
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
83 **Output**
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
84
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
85 As output the tool give you out a file in biobox format with the added column 'Length'. This file then can be used for AMBER as example!
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
86
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
87
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
88 ]]>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
89 </help>
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
90 <expand macro="citations" />
22385c4e11a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
iuc
parents:
diff changeset
91 </tool>