annotate vcf.xml @ 0:4cf5a2dd27dd draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
author iuc
date Mon, 20 Jan 2025 16:31:16 +0000
parents
children 974b39eb89b6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
1 <tool id="cnvkit_export_vcf" name="CNVkit Export VCF" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
2 <description>Converts the Segmented copy ratio data file (*.cns) file into VCF file</description>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
3 <macros>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
4 <import>macros.xml</import>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
5 </macros>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
6 <expand macro="xrefs"/>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
7 <expand macro="creators"/>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
8 <expand macro="requirements"/>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
10 ln -s '$input_segmented_file' ./sample.cns &&
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
11 ln -s '$advanced_settings.cnr' ./sample.cnr &&
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
12 cnvkit.py export vcf
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
13 ./sample.cns
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
14 #if $advanced_settings.cnr
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
15 --cnr ./sample.cnr
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
16 #end if
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
17 #if $advanced_settings.sample_id
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
18 --sample-id '$advanced_settings.sample_id'
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
19 #end if
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
20 #if $advanced_settings.ploidy
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
21 --ploidy $advanced_settings.ploidy
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
22 #end if
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
23 #if str($advanced_settings.sample_sex) and $advanced_settings.sample_sex != ""
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
24 --sample-sex '$advanced_settings.sample_sex'
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
25 #end if
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
26 $advanced_settings.male_reference
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
27 --output sample.cnv.vcf
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
28 #if $advanced_settings.diploid_parx_genome
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
29 --diploid-parx-genome '$advanced_settings.diploid_parx_genome'
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
30 #end if
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
31 ]]></command>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
32 <inputs>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
33 <param name="input_segmented_file" type="data" format="tabular" label="Segmented Copy Ratio Data File (cns file)" help="" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
34 <section name="advanced_settings" title="Advanced settings" expanded="false">
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
35 <param argument="--cnr" optional="true" type="data" format="tabular" label="Bin-level copy ratios (cnr)" help="" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
36 <param argument="--sample-id" optional="true" type="text" label="Sample ID" value="" help="Sample name to write in the genotype field of the output VCF file" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
37 <param argument="--ploidy" optional="true" type="integer" label="Ploidy" min="1" value="2" help="Ploidy of the sample cells. [Default: 2]" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
38 <expand macro="sample_sex"/>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
39 <param argument="--male-reference" type="boolean" checked="false" truevalue="--male-reference" falsevalue="" label="MALE REFERENCE" help="Assume inputs were normalized to a male reference" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
40 <param argument="--diploid-parx-genome" optional="true" type="text" label="Diploid Parx Genome" value="" help="Considers the given human genome's PAR of chromosome X as autosomal. Example: 'grch38'" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
41 </section>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
42 </inputs>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
43 <outputs>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
44 <data name="CNVs_VCF" format="vcf" label="${tool.name} on ${on_string}: CNVs VCF file" from_work_dir="sample.cnv.vcf" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
45 </outputs>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
46 <tests>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
47 <test expect_num_outputs="1">
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
48 <param name="input_segmented_file" ftype="tabular" value="sample.cns" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
49 <param name="sample_id" value="SampleID" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
50 <param name="sample_sex" value="Female" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
51 <output name="CNVs_VCF" file="sample.cnv.vcf" ftype="vcf" lines_diff="2" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
52 </test>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
53 </tests>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
54 <help><![CDATA[
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
55 Export the segmented copy number data (from a .cns file) to the standard VCF 4.2 format.
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
56 The resulting VCF file describes copy number gains and losses across each segment and contains
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
57 INFO fields for breakpoints (CIPOS, CIEND) if bin-level data (.cnr) is provided.
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
58 ]]></help>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
59 <expand macro="citations" />
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
60 </tool>
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
61
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
62
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
63
4cf5a2dd27dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cnvkit commit 51995527835d18a4a3a498b140382ce433f19a71
iuc
parents:
diff changeset
64