annotate AddMissingCoverage.xml @ 0:a3129cb0af43 default tip

initial commit
author Yusuf Ali <ali@yusuf.email>
date Wed, 25 Mar 2015 13:02:25 -0600
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
1 <?xml version="1.0"?>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
2
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
3 <tool id="hgvs_add_coverage" name="Add poor/missing coverage info">
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
4 <description>to an annotated HGVS table</description>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
5 <version_string>hgvs_add_missing_sample_coverage -v</version_string>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
6 <command interpreter="perl">hgvs_add_missing_sample_coverage $input_hgvs_annotated_table $out_hgvs_annotated_table $sample_name $sample_bam $max_homo_fn_coverage $max_het_fn_coverage $min_mapq $min_baq</command>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
7 <inputs>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
8 <param format="achri_annotated_snp_table" name="input_hgvs_annotated_table" type="data" label="Annotated variant calls table with HGVS syntax"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
9 <param name="sample_name" type="text" label="Name of sample to check for read coverage"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
10 <param name="sample_bam" type="data" format="bam" label="Mapped reads to be checked (BAM format)" help="For each variant in the input table that does NOT include the specified sample name in the Sources column, this BAM file will be checked for concordant reads"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
11 <param name="max_homo_fn_coverage" label="Minimum read coverage to exclude false negative homozygous variants" type="integer" min="1" value="3" />
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
12 <param name="max_het_fn_coverage" label="Minimum read coverage to exclude false negative heterozygous variants" type="integer" min="1" value="20" />
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
13 <param name="min_mapq" label="Minimum mapping quality score to consider a read" type="integer" min="1" value="20" help="(10=p-value 0.1, 20=p-value 0.01, etc.)"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
14 <param name="min_baq" label="Minimum base quality score to consider a read" type="integer" min="1" value="20" help="(10=p-value 0.1, 20=p-value 0.01, etc.)"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
15 </inputs>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
16 <outputs>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
17 <data format="achri_annotated_snp_table" name="out_hgvs_annotated_table" type="data" label="Variant table with poor/missing coverage data for ${sample_name}"/>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
18 </outputs>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
19
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
20 <tests>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
21 </tests>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
22
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
23 <help>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
24 Once this tools is run, lack of the given sample name in a table row means the sample almost definitely does not contain the variant that row reports.
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
25 This tool adds a sample to the Sources column of the variant table if it is not already there, but the given BAM file either:
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
26
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
27 1. has at least 1/max_het_fn_coverage read proportion supporting the variant (in which case the sample name is added with a "+"), or
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
28
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
29 2. has fewer than max_homo_fn_coverage or max_het_fn_coverage reads mapped in total, and those reads neither conflict with nor support the variant called (in which case the sample name is added with a "~")
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
30 </help>
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
31
a3129cb0af43 initial commit
Yusuf Ali <ali@yusuf.email>
parents:
diff changeset
32 </tool>