annotate cgatools_suite/tools/cgatools/snpdiff.xml @ 12:a48451470c73 draft

Uploaded
author bcrain-completegenomics
date Wed, 06 Jun 2012 18:24:37 -0400
parents 96829b1b73ea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_snpdiff" name="snpdiff" version="0.0.1">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
2
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
3 <description>compares snp calls to a Complete Genomics variant file.</description> <!--adds description in toolbar-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
4
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
5 <requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
6 <requirement type="binary">cgatools</requirement>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
7 </requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
8
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
9 <command> <!--run executable-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
10 cgatools snpdiff --beta -h
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
11 </command>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
12
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
13 <outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
14 <data format="tabular" name="output" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
15 </outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
16
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
17 <inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
18 </inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
19
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
20 <help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
21
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
22 **What it does**
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
23
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
24 This tool ompares snp calls to a Complete Genomics variant file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
25
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
26 cgatools: http://sourceforge.net/projects/cgatools/files/
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
27
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
28 -----
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
29
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
30 **cgatools Manual**::
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
31
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
32 COMMAND NAME
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
33 snpdiff - Compares snp calls to a Complete Genomics variant file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
34
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
35 DESCRIPTION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
36 Compares the snp calls in the "genotypes" file to the calls in a Complete
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
37 Genomics variant file. The genotypes file is a tab-delimited file with at
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
38 least the following columns (additional columns may be given):
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
39
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
40 Chromosome (Required) The name of the chromosome.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
41 Offset0Based (Required) The 0-based offset in the chromosome.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
42 GenotypesStrand (Optional) The strand of the calls in the Genotypes
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
43 column (+ or -, defaults to +).
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
44 Genotypes (Optional) The calls, one per allele. The following
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
45 calls are recognized:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
46 A,C,G,T A called base.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
47 N A no-call.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
48 - A deleted base.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
49 . A non-snp variation.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
50
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
51 The output is a tab-delimited file consisting of the columns of the
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
52 original genotypes file, plus the following additional columns:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
53
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
54 Reference The reference base at the given position.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
55 VariantFile The calls made by the variant file, one per allele.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
56 The character codes are the same as is described for
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
57 the Genotypes column.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
58 DiscordantAlleles (Only if Genotypes is present) The number of
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
59 Genotypes alleles that are discordant with calls in
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
60 the VariantFile. If the VariantFile is described as
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
61 haploid at the given position but the Genotypes is
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
62 diploid, then each genotype allele is compared
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
63 against the haploid call of the VariantFile.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
64 NoCallAlleles (Only if Genotypes is present) The number of
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
65 Genotypes alleles that were no-called by the
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
66 VariantFile. If the VariantFile is described as
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
67 haploid at the given position but the Genotypes is
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
68 diploid, then a VariantFile no-call is counted twice.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
69
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
70 The verbose output is a tab-delimited file consisting of the columns of the
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
71 original genotypes file, plus the following additional columns:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
72
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
73 Reference The reference base at the given position.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
74 VariantFile The call made by the variant file for one allele (there is
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
75 a line in this file for each allele). The character codes
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
76 are the same as is described for the Genotypes column.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
77 [CALLS] The rest of the columns are pasted in from the VariantFile,
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
78 describing the variant file line used to make the call.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
79
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
80 The stats output is a comma-separated file with several tables describing
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
81 the results of the snp comparison, for each diploid genotype. The tables
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
82 all describe the comparison result (column headers) versus the genotype
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
83 classification (row labels) in different ways. The "Locus classification"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
84 tables have the most detailed match classifications, while the "Locus
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
85 concordance" tables roll these match classifications up into "discordance"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
86 and "no-call". A locus is considered discordant if it is discordant for
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
87 either allele. A locus is considered no-call if it is concordant for both
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
88 alleles but has a no-call on either allele. The "Allele concordance"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
89 describes the comparison result on a per-allele basis.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
90
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
91 OPTIONS
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
92 -h [ --help ]
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
93 Print this help message.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
94
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
95 --reference arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
96 The input crr file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
97
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
98 --variants arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
99 The input variant file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
100
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
101 --genotypes arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
102 The input genotypes file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
103
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
104 --output-prefix arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
105 The path prefix for all output reports.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
106
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
107 --reports arg (=Output,Verbose,Stats)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
108 Comma-separated list of reports to generate. A report is one of:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
109 Output The output genotypes file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
110 Verbose The verbose output file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
111 Stats The stats output file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
112
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
113 SUPPORTED FORMAT_VERSION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
114 0.3 or later
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
115 </help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
116 </tool>