annotate tool_dependencies.xml @ 4:bf68642a6d3e draft default tip

Uploaded
author chrisw
date Tue, 19 Nov 2019 05:40:59 +0000
parents 8e9a8987581c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
1 <?xml version="1.0"?>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
2 <tool_dependency>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
3 <!--
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
4 <package name="htslib" version="1.9"/>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
5 <package name="libbigwig" version="0.4.2"/>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
6 -->
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
7 <package name="bamcount" version="0.4.0">
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
8 <install version="1.0">
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
9 <actions_group>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
10 <actions architecture="x86_64" os="linux">
4
bf68642a6d3e Uploaded
chrisw
parents: 2
diff changeset
11 <action type="download_by_url">https://github.com/ChristopherWilks/bamcount/releases/download/0.4.0/bamcount-0.4.0_static.zip</action>
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
12 <action type="move_directory_files">
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
13 <source_directory>.</source_directory>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
14 <destination_directory>$INSTALL_DIR</destination_directory>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
15 </action>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
16 </actions>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
17 <action type="set_environment">
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
18 <environment_variable action="prepend_to" name="PATH">$INSTALL_DIR</environment_variable>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
19 </action>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
20 </actions_group>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
21 </install>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
22 <readme><![CDATA[
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
23 bamcount 0.4.0
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
24
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
25 BAM and BigWig utility.
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
26
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
27 Usage:
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
28 bamcount <bam> [options]
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
29
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
30 Options:
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
31 -h --help Show this screen.
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
32 --version Show version.
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
33 --threads # of threads to do BAM decompression
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
34
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
35 Extract basic junction information from the BAM, including co-occurrence
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
36 --junctions <prefix> Extract jx coordinates, strand, and anchor length, per read
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
37 Writes to a TSV file <prefix>.jxs.tsv
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
38
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
39 Extract reads from BAM into FASTQ (exclusive of all other modes):
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
40 --bam2fastq <prefix> Extract all reads from the passed in BAM and output as FASTQs
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
41 Uses prefix to name the fastq(s)
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
42 --filter-out SAM bit flags to filter out
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
43 --filter-in SAM bit flags to filter in
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
44 --re-reverse If read is reversed in alignment, re-reverse it in output
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
45 --one-file If you know file is not paired or just want all reads in one file
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
46
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
47 Non-reference summaries:
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
48 --alts <prefix> Print differing from ref per-base coverages
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
49 Writes to a CSV file <prefix>.alts.tsv
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
50 --include-softclip <prefix> Print a record to the alts CSV for soft-clipped bases
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
51 Writes total counts to a separate TSV file <prefix>.softclip.tsv
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
52 --only-polya If --include-softclip, only print softclips which are mostly A's or T's
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
53 --include-n Print mismatch records when mismatched read base is N
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
54 --print-qual Print quality values for mismatched bases
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
55 --delta Print POS field as +/- delta from previous
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
56 --require-mdz Quit with error unless MD:Z field exists everywhere it's
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
57 expected
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
58 --no-head Don't print sequence names and lengths in header
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
59
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
60 Coverage and quantification:
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
61 --coverage Print per-base coverage (slow but totally worth it)
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
62 --auc <prefix> Print per-base area-under-coverage, will generate it for the genome
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
63 and for the annotation if --annotation is also passed in
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
64 Writes to a TSV file <prefix>.auc.tsv
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
65 --bigwig <prefix> Output coverage as BigWig file(s). Writes to <prefix>.all.bw
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
66 (also <prefix>.unique.bw when --min-unique-qual is specified).
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
67 Requires libBigWig.
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
68 --annotation <bed> <prefix>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
69 Path to BED file containing list of regions to sum coverage over
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
70 (tab-delimited: chrm,start,end)
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
71 --keep-bam-order Output annotation coverage in the order chromosomes appear in the BAM file.
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
72 The default is to output annotation coverage in the order chromosomes appear in the BED file.
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
73 --min-unique-qual <int>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
74 Output second bigWig consisting built only from alignments
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
75 with at least this mapping quality. --bigwig must be specified.
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
76 Also produces second set of annotation sums based on this coverage
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
77 if --annotation is enabled
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
78 --double-count Allow overlapping ends of PE read to count twice toward
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
79 coverage
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
80 --num-bases Report total sum of bases in alignments processed (that pass filters)
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
81
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
82 Other outputs:
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
83 --read-ends Print counts of read starts/ends, if --min-unique-qual is set
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
84 then only the alignments that pass that filter will be counted here
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
85 Writes to 2 TSV files: <prefix>.starts.tsv, <prefix>.ends.tsv
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
86 --frag-dist <prefix> Print fragment length distribution across the genome
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
87 Writes to a TSV file <prefix>.frags.tsv
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
88 --echo-sam Print a SAM record for each aligned read
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
89 --ends Report end coordinate for each read (useful for debugging)
1
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
90 --test-polya Lower Poly-A filter minimums for testing (only useful for debugging/testing)
cb4c1efac7af Uploaded
chrisw
parents: 0
diff changeset
91 ]]></readme>
0
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
92 </package>
f02b4483eda2 Uploaded
chrisw
parents:
diff changeset
93 </tool_dependency>