Mercurial > repos > iuc > bcftools_merge
annotate README.md @ 4:df40d7f9737c draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit 3edcac645f34d5a94884dedaf95c5774f4afc5c7
author | iuc |
---|---|
date | Sat, 11 Mar 2017 18:00:12 -0500 |
parents | 5add48c63b9a |
children |
rev | line source |
---|---|
0
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
1 # bcftools (v1.3) |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
2 |
5add48c63b9a
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: |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
4 |
5add48c63b9a
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
df40d7f9737c
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
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
7 |
5add48c63b9a
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 |
5add48c63b9a
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 |
5add48c63b9a
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. |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
11 |
5add48c63b9a
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 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
13 |
4
df40d7f9737c
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
5add48c63b9a
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. |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
16 |
4
df40d7f9737c
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
5add48c63b9a
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
df40d7f9737c
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
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
20 |
5add48c63b9a
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" |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
22 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
23 ## TODO: |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
24 |
5add48c63b9a
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 |
5add48c63b9a
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. |
5add48c63b9a
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 |
5add48c63b9a
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 |
5add48c63b9a
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
df40d7f9737c
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
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
31 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
32 ## Status |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
33 |
5add48c63b9a
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% |
5add48c63b9a
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 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
36 bit slower. |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
37 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
38 - [x] annotate |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
39 - [x] call |
5add48c63b9a
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) |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
41 - [x] concat |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
42 - [x] consensus |
5add48c63b9a
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 |
5add48c63b9a
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 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
45 - [x] filter |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
46 - [x] gtcheck |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
47 - [x] isec |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
48 - [x] merge |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
49 - [x] norm |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
50 - [x] query |
5add48c63b9a
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 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
52 - [x] reheader |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
53 - [x] roh |
5add48c63b9a
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) |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
55 - [x] view |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
56 - [ ] +color chrs |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
57 - [x] +counts |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
58 - [x] +dosage |
5add48c63b9a
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 |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
60 - [x] +fill tags |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
61 - [x] +fixploidy |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
62 - [ ] +frameshifts |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
63 - [x] +impute info |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
64 - [x] +mendelian |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
65 - [x] +missing2ref |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
66 - [x] +setgt |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
67 - [x] +tag2tag |
5add48c63b9a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bcftools commit ef90c4602bdb83ea7455946c9d175ea27284e643
iuc
parents:
diff
changeset
|
68 - [x] +vcf2sex |