annotate README.md @ 17:22637b1a55bf draft

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