Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Mirrors
biopet.biopet
Commits
b701cbe6
Commit
b701cbe6
authored
Jul 05, 2016
by
Moustakas
Browse files
Create a documentation for AnnotateVcfWithBed
parent
acd85018
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/tools/AnnotateVcfWithBed.md
View file @
b701cbe6
# AnnotateVcfWithBed
## Introduction
This tool to annotates a vcf file with input from a bed file
## Example
To get the help menu:
~~~
Usage: AnnotateVcfWithBed [options]
-l <value> | --log_level <value>
Log level
-h | --help
Print usage
-v | --version
Print version
-I <vcf file> | --inputFile <vcf file>
Input is a required file property
-B <bed file> | --bedFile <bed file>
Bedfile is a required file property
-o <vcf file> | --output <vcf file>
out is a required file property
-f <name of field in vcf file> | --fieldName <name of field in vcf file>
Name of info field in new vcf file
-d <name of field in vcf file> | --fieldDescription <name of field in vcf file>
Description of field in new vcf file
-t <name of field in vcf file> | --fieldType <name of field in vcf file>
Description of field in new vcf file
~~~
To run the tool:
~~~
biopet tool AnnotateVcfWithBed -I myVcf.vcf -B myBed.bed -o myannotatedVcf.vcf
~~~
## Results
The result of this tool will be a vcf file with an extra field with annotation
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment