annotate bamcount.xml @ 0:1f0e3aaaba19 draft

Uploaded
author chrisw
date Tue, 12 Feb 2019 13:42:37 -0500
parents
children 78bca99736b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
1 <tool id="bamcount" name="Summarize coverage from a BAM (bamcount)" version="0.1.0">
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
2 <requirements>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
3 <requirement type="package" version="0.2.6">bamcount</requirement>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
4 </requirements>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
6 bamcount "$input1" --threads $threads --coverage --no-head --require-mdz --min-unique-qual $min_uniq_qual --frag-dist bc --bigwig bc --annotation $annotation bc --auc bc --alts bc
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
7 ]]></command>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
8 <inputs>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
9 <param type="data" name="input1" format="bam" />
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
10 </inputs>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
11 <outputs>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
12 <data name="output1" format="auc.tsv" from_work_dir="bc.auc.tsv" />
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
13 </outputs>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
14 <tests>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
15 <test>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
16 <param name="input1" value="test.bam"/>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
17 <output name="output1" file="bc.auc.tsv"/>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
18 </test>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
19 </tests>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
20 <help><![CDATA[
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
21 bamcount 0.2.6
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
22
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
23 BAM and BigWig utility.
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
24
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
25 Usage:
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
26 bamcount <bam> [options]
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
27
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
28 Options:
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
29 -h --help Show this screen.
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
30 --version Show version.
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
31 --threads # of threads to do BAM decompression
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
32
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
33 Non-reference summaries:
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
34 --alts <prefix> Print differing from ref per-base coverages
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
35 Writes to a CSV file <prefix>.alts.tsv
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
36 --include-softclip Print a record for soft-clipped bases
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
37 --include-n Print mismatch records when mismatched read base is N
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
38 --print-qual Print quality values for mismatched bases
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
39 --delta Print POS field as +/- delta from previous
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
40 --require-mdz Quit with error unless MD:Z field exists everywhere it's
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
41 expected
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
42 --no-head Don't print sequence names and lengths in header
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
43
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
44 Coverage and quantification:
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
45 --coverage Print per-base coverage (slow but totally worth it)
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
46 --auc <prefix> Print per-base area-under-coverage, will generate it for the genome
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
47 and for the annotation if --annotation is also passed in
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
48 Writes to a TSV file <prefix>.auc.tsv
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
49 --bigwig <prefix> Output coverage as BigWig file(s). Writes to <prefix>.all.bw
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
50 (also <prefix>.unique.bw when --min-unique-qual is specified).
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
51 Requires libBigWig.
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
52 --annotation <bed> <prefix>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
53 Path to BED file containing list of regions to sum coverage over
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
54 (tab-delimited: chrm,start,end)
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
55 --min-unique-qual <int>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
56 Output second bigWig consisting built only from alignments
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
57 with at least this mapping quality. --bigwig must be specified.
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
58 Also produces second set of annotation sums based on this coverage
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
59 if --annotation is enabled
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
60 --double-count Allow overlapping ends of PE read to count twice toward
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
61 coverage
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
62 --num-bases Report total sum of bases in alignments processed (that pass filters)
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
63
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
64 Other outputs:
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
65 --read-ends Print counts of read starts/ends, if --min-unique-qual is set
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
66 then only the alignments that pass that filter will be counted here
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
67 Writes to 2 TSV files: <prefix>.starts.tsv, <prefix>.ends.tsv
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
68 --frag-dist <prefix> Print fragment length distribution across the genome
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
69 Writes to a TSV file <prefix>.frags.tsv
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
70 --echo-sam Print a SAM record for each aligned read
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
71 --ends Report end coordinate for each read (useful for debugging)
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
72 ]]></help>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
73 <citations>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
74 <citation type="bibtex">
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
75 @misc{githubbamcount,
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
76 author = {Wilks, Christopher},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
77 year = {2019},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
78 title = {bamcount},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
79 publisher = {GitHub},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
80 journal = {GitHub repository},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
81 url = {https://github.com/BenLangmead/bamcount},
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
82 }</citation>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
83 </citations>
1f0e3aaaba19 Uploaded
chrisw
parents:
diff changeset
84 </tool>