Mercurial > repos > iuc > bcftools_csq

annotate README.md @ 15:e6f4badbe6f3 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit bfc4ff4956b94885638ae07a2560bac5f84fcca8
author iuc
date Tue, 16 Jul 2024 17:19:27 +0000
parents 2a6c13f8cc5a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
1 # bcftools (v1.3)
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
2
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
3 Copied from branch bcftools1.2:
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
4
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
5 This aims to be a "faithful" rendering of the bcftool suite. I.e. options are
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
6 presented essentially as closely to the command line version as is useful.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
7
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
8 This may not appeal to all, if you'd like to see smaller and more dedicated
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
9 tools (e.g. "intersect", "union" and "complement" being separate tools instead
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
10 of all of them included in the "isec" tool,) please feel free to file an issue.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
11
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
12 Updated for bcftools v1.3
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
13
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
14 This was extended from the bcftools1.2 branch then greatly hand edited to
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
15 group params and manage param innteractions.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
16
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
17 In the macros.xml there are macros and tokens to handle file input and output.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
18 These use the datatypes currently available in galaxy: Vcf and Bcf
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
19 The macros take care of bgzip and indexing of inputs.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
20
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
21 The convert command was split into 2 tools, "convert to vcf" and "convert from vcf"
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
22
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
23 ## TODO:
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
24
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
25 - stats needs a matplotlib tool dependency and pdflatex for generating a pdf of plots
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
26 - cnv needs a matplotlib tool dependency for generating images, then a means to consolidate those.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
27 - cnv needs an input.vcf for testing, runs with bcftools cnv -s "HG00101" -o 'HG00101/' -p 5 mpileup.vcf
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
28 - roh needs a more useful input.vcf for testing
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
29 - plugin color chrs
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
30 - plugin frameshifts
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
31
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
32 ## Status
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
33
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
34 The wrappers were automatically generated in bulk. That doesn't get them 100%
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
35 of the way there (e.g. meaningful test cases), so the rest of the process is a
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
36 bit slower.
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
37
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
38 - [x] annotate
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
39 - [x] call
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
40 - [ ] cnv (needs real test data, needs plotting)
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
41 - [x] concat
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
42 - [x] consensus
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
43 - [x] convert from vcf
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
44 - [x] convert to vcf
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
45 - [x] filter
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
46 - [x] gtcheck
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
47 - [x] isec
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
48 - [x] merge
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
49 - [x] norm
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
50 - [x] query
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
51 - [x] query list samples
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
52 - [x] reheader
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
53 - [x] roh
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
54 - [x] stats (needs plotting)
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
55 - [x] view
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
56 - [ ] +color chrs
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
57 - [x] +counts
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
58 - [x] +dosage
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
59 - [x] +fill an ac
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
60 - [x] +fill tags
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
61 - [x] +fixploidy
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
62 - [ ] +frameshifts
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
63 - [x] +impute info
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
64 - [x] +mendelian
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
65 - [x] +missing2ref
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
66 - [x] +setgt
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
67 - [x] +tag2tag
2a6c13f8cc5a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 9d03fe38504a35d11660dadb44cb1beee32fcf4e
iuc
parents:
diff changeset
68 - [x] +vcf2sex