annotate cnv-vcf2json.xml @ 1:6763389420f5 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
author iuc
date Sat, 01 Mar 2025 11:47:41 +0000
parents 9be5490bb681
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
1 <tool id="cnv_vcf2json" name="CNV VCF2JSON" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
1
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
2 <description>Converts the CNVkit structural variants VCF file to JSON</description>
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
3 <macros>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
4 <import>macros.xml</import>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
5 </macros>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
7 <expand macro="creators"/>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
9 #import re
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
10 ln -s '$input_vcf_file' ./input.vcf &&
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
11 cnv-vcf2json
1
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
12 ./input.vcf
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
13 #if $advanced_settings.assembly
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
14 --assembly '$advanced_settings.assembly'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
15 #end if
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
16 #if $advanced_settings.analysis
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
17 --analysis '$advanced_settings.analysis'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
18 #end if
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
19 #if $advanced_settings.individual
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
20 --individual '$advanced_settings.individual'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
21 #end if
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
22 #if $advanced_settings.sequence
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
23 --sequence '$advanced_settings.sequence'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
24 #end if
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
25 #if $advanced_settings.reference
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
26 --reference '$advanced_settings.reference'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
27 #end if
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
28 #if $advanced_settings.fusion
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
29 --fusion '$advanced_settings.fusion'
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
30 #end if
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
31 -o output.json
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
32 ]]></command>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
33 <inputs>
1
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
34 <param name="input_vcf_file" type="data" format="vcf" label="CNVkit VCF file" help="The file Generated from CNVkit Export" />
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
35 <section name="advanced_settings" title="Advanced settings" expanded="false">
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
36 <param argument="--assembly" type="text" optional="true" label="Assembly Identifier" help="For example: GRCh37" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
37 <validator type="regex">^[0-9a-zA-Z_ .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
38 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
39 <param argument="--analysis" type="text" optional="true" label="Analysis Identifier" help="" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
40 <validator type="regex">^[0-9a-zA-Z_,: .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
41 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
42 <param argument="--individual" type="text" optional="true" label="Individual Identifier" help="" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
43 <validator type="regex">^[0-9a-zA-Z_,: .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
44 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
45 <param argument="--sequence" type="text" optional="true" label="Variant Sequence" help="" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
46 <validator type="regex">^[0-9a-zA-Z_,: .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
47 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
48 <param argument="--reference" type="text" optional="true" label="Reference Sequence" help="" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
49 <validator type="regex">^[0-9a-zA-Z_,: .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
50 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
51 <param argument="--fusion" type="text" optional="true" label="Fusion Identifier" help="" >
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
52 <validator type="regex">^[0-9a-zA-Z_,: .-]+$</validator>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
53 </param>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
54 </section>
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
55 </inputs>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
56 <outputs>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
57 <data name="output_json" format="json" label="${tool.name} on ${on_string}: CNV JSON File" from_work_dir="output.json" />
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
58 </outputs>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
59 <tests>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
60 <test expect_num_outputs="1">
1
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
61 <param name="input_vcf_file" ftype="vcf" value="input.vcf" />
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
62 <param name="assembly" value="GRCh37" />
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
63 <output name="output_json">
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
64 <assert_contents>
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
65 <has_json_property_with_text property="biosampleId" text="SampleID" />
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
66 </assert_contents>
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
67 </output>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
68 </test>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
69 </tests>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
70 <help><![CDATA[
1
6763389420f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit fc1282ec68b346988203ead860e9b9d6a47e9efb
iuc
parents: 0
diff changeset
71 The tool converts the structural variants VCF file generated from the CNVkit export subcommand into JSON file as a preprocessing step to import the data into Beacon2 MongoDB protocol
0
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
72 ]]></help>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
73 <expand macro="citations"/>
9be5490bb681 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnv-vcf2json commit 7b5c842d3c006d2afd00aff1ef833f236a45dd3d
iuc
parents:
diff changeset
74 </tool>