Mercurial > repos > jjohnson > bcftools_plugin_frameshifts

annotate README.md @ 1:eb0cb4a5f478 draft default tip

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