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
13c61914
Commit
13c61914
authored
Jul 14, 2016
by
Moustakas
Browse files
Improve phrasing and options description
parent
68b4e6d8
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/tools/VcfFilter.md
View file @
13c61914
# VcfFilter
## Introduction
This tool filters VCF files on a number values. For example, it can filter on sample depth and/or total depth.
It can also filter out the reference calls and/or minimum number of sample passes.
For more on filtering options and how to set them, please refer to the help menu.
This tool enables a user to filter VCF files. For example on sample depth and/or total depth.
It can also be used to filter out the reference calls and/or minimum number of sample passes.
There is a wide set of options which one can use to change the filter settings.
...
...
@@ -32,19 +37,19 @@ Usage: VcfFilter [options]
Min number of samples to pass
--minAlternateDepth
,
--minBamAlternateDepth
and
--minSampleDepth
--minBamAlternateDepth
<int>
--denovoInSample
<sample>
Only
show
variants that contain unique alleles
in
compete
set
for
given sample
Only
keep
variants that contain unique alleles
in
comp
l
ete set
for
the
given sample
--mustHaveVariant
<sample>
G
iven sample
must
have
1
alternative allele
Only keep variants that
for
the g
iven sample have
an
alternative allele
--diffGenotype
<sample:sample>
G
iven samples
must
have a different genotype
--filterHetVarToHomVar
<sample:sample>
If variants
in
sample 1 are heterogeneous and alternative alleles are
homo
gene
ous
in
sample
2 variants are filtered
Only keep variands that
for
the g
iven samples have a different genotype
--filterHetVarToHomVar
<sample
1
:sample
2
>
Filter out varianst that are heterozygous
in
sample1 and
homo
zyg
ous
in
sample
2
--filterRefCalls
Filter
when there are only
ref calls
Filter
out
ref calls
--filterNoCalls
Filter
when there are only
no calls
Filter
out
no calls
--minQualScore
<value>
Min qual score
Filter out variants with Min qual score below threshold
~~~
To run the tool:
...
...
@@ -54,4 +59,4 @@ biopet tool VcfFilter --inputVcf myInput.vcf \
~~~
## Output
The output is a vcf file containing the filters specified values.
\ No newline at end of file
The output is a vcf file containing the values that pass the user-defined filtering options
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