annotate README.md @ 10:a9547524b473 draft

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