annotate tools/cgatools17/snpdiff_v17.xml @ 5:64017ce705b6 draft

planemo upload for repository https://bitbucket.org/EMCbioinf/galaxy-tool-shed-tools commit c475b4222a15cdadc6085865f4d13426249fec25-dirty
author yhoogstrate
date Wed, 11 Nov 2015 03:51:05 -0500
parents 3a2e0f376f26
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
1 <tool id="cg_snpdiff" name="SNPDiff" version="1.7.1">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
2
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
3 <description>compares snp calls to a Complete Genomics variant file.</description>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
4
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
5 <requirements>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
6 <requirement type="package" version="1">cgatools17</requirement>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
7 </requirements>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
8
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
9 <command>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
10 cgatools | head -1;
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
11 cgatools snpdiff
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
12 --reference ${crr.fields.crr_path}
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
13 --variants $varfile
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
14 --genotypes $genotype
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
15 --output-prefix cg_
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
16 --reports `echo ${report1} ${report2} ${report3} | sed 's/ */,/g'`
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
17 </command>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
18
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
19 <inputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
20 <param name="crr" type="select" label="Reference build">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
21 <options from_data_table="cg_anno_files" />
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
22 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
23 <param name="varfile" type="data" format="cg_var" label="Var file"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
24
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
25 <param name="genotype" type="data" format="tabular" label="Genotypes file with SNP calls" help="The genotypes file is a tab-delimited file with at least the following columns (additional columns may be given): Chromosome (Required), Offset0Based (Required), GenotypesStrand (Optional), Genotypes (Optional)"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
26
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
27 <param name="report1" type="select" label="Create report Output">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
28 <option value="">no</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
29 <option value="Output">yes</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
30 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
31 <param name="report2" type="select" label="Create report Verbose">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
32 <option value="">no</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
33 <option value="Verbose">yes</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
34 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
35 <param name="report3" type="select" label="Create report Stats">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
36 <option value="">no</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
37 <option value="Stats">yes</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
38 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
39 <param name="fname" type="text" value="" label="Prefix for your output file" help="Optional"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
40 </inputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
41
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
42 <outputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
43 <data format="tabular" name="output1" from_work_dir="cg_Output.tsv" label="$fname ${tool.name} on ${on_string}: Output">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
44 <filter>(report1 == 'Output')</filter>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
45 </data>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
46 <data format="tabular" name="output2" from_work_dir="cg_Verbose.tsv" label="$fname ${tool.name} on ${on_string}: Verbose">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
47 <filter>(report2 == 'Verbose')</filter>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
48 </data>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
49 <data format="tabular" name="output3" from_work_dir="cg_Stats.tsv" label="$fname ${tool.name} on ${on_string}: Stats">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
50 <filter>(report3 == 'Stats')</filter>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
51 </data>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
52 </outputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
53 <help>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
54 **What it does**
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
55
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
56 This tool ompares snp calls to a Complete Genomics variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
57
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
58 **cgatools 1.7.1 Documentation**
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
59
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
60 Userguide: http://cgatools.sourceforge.net/docs/1.7.1/cgatools-user-guide.pdf
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
61
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
62 Release notes: http://cgatools.sourceforge.net/docs/1.7.1/cgatools-release-notes.pdf
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
63
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
64 **Command line reference**::
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
65
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
66 COMMAND NAME
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
67 snpdiff - Compares snp calls to a Complete Genomics variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
68
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
69 DESCRIPTION
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
70 Compares the snp calls in the "genotypes" file to the calls in a Complete
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
71 Genomics variant file. The genotypes file is a tab-delimited file with at
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
72 least the following columns (additional columns may be given):
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
73
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
74 Chromosome (Required) The name of the chromosome.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
75 Offset0Based (Required) The 0-based offset in the chromosome.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
76 GenotypesStrand (Optional) The strand of the calls in the Genotypes
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
77 column (+ or -, defaults to +).
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
78 Genotypes (Optional) The calls, one per allele. The following
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
79 calls are recognized:
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
80 A,C,G,T A called base.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
81 N A no-call.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
82 - A deleted base.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
83 . A non-snp variation.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
84
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
85 The output is a tab-delimited file consisting of the columns of the
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
86 original genotypes file, plus the following additional columns:
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
87
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
88 Reference The reference base at the given position.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
89 VariantFile The calls made by the variant file, one per allele.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
90 The character codes are the same as is described for
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
91 the Genotypes column.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
92 DiscordantAlleles (Only if Genotypes is present) The number of
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
93 Genotypes alleles that are discordant with calls in
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
94 the VariantFile. If the VariantFile is described as
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
95 haploid at the given position but the Genotypes is
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
96 diploid, then each genotype allele is compared
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
97 against the haploid call of the VariantFile.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
98 NoCallAlleles (Only if Genotypes is present) The number of
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
99 Genotypes alleles that were no-called by the
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
100 VariantFile. If the VariantFile is described as
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
101 haploid at the given position but the Genotypes is
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
102 diploid, then a VariantFile no-call is counted twice.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
103
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
104 The verbose output is a tab-delimited file consisting of the columns of the
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
105 original genotypes file, plus the following additional columns:
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
106
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
107 Reference The reference base at the given position.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
108 VariantFile The call made by the variant file for one allele (there is
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
109 a line in this file for each allele). The character codes
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
110 are the same as is described for the Genotypes column.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
111 [CALLS] The rest of the columns are pasted in from the VariantFile,
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
112 describing the variant file line used to make the call.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
113
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
114 The stats output is a comma-separated file with several tables describing
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
115 the results of the snp comparison, for each diploid genotype. The tables
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
116 all describe the comparison result (column headers) versus the genotype
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
117 classification (row labels) in different ways. The "Locus classification"
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
118 tables have the most detailed match classifications, while the "Locus
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
119 concordance" tables roll these match classifications up into "discordance"
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
120 and "no-call". A locus is considered discordant if it is discordant for
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
121 either allele. A locus is considered no-call if it is concordant for both
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
122 alleles but has a no-call on either allele. The "Allele concordance"
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
123 describes the comparison result on a per-allele basis.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
124
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
125 OPTIONS
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
126 -h [ --help ]
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
127 Print this help message.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
128
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
129 --reference arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
130 The input crr file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
131
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
132 --variants arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
133 The input variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
134
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
135 --genotypes arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
136 The input genotypes file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
137
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
138 --output-prefix arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
139 The path prefix for all output reports.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
140
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
141 --reports arg (=Output,Verbose,Stats)
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
142 Comma-separated list of reports to generate. A report is one of:
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
143 Output The output genotypes file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
144 Verbose The verbose output file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
145 Stats The stats output file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
146
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
147 SUPPORTED FORMAT_VERSION
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
148 0.3 or later
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
149 </help>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
150 </tool>