Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

created the VarTable options list #12

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions OPTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## VarTable Options



Usage
---------

$ vartable_report --input-vcf [../filename.vcf] --type [basecaller] \
--input-bam [../filename.bam] --input-ref [../filename.fasta] \
--minpercent [20] --minbq [25] --mindepth [10] \
--output-err [filename.err] --input-prm [../filename.fasta] \
--output-name [filename.tsv] --input-region [10 200] \
--stats

## (Required)
**--input-vcf** input VCF file

**--type** input flag (base_caller | lofreq), this differentiates b/t a VCF with all positions and VCF with only variant positions

**--input-bam** input BAM file

**--input-ref** input reference FASTA file or GenBank, gb extension file (this will parse for annotated information)

fungshui marked this conversation as resolved.
Show resolved Hide resolved
**--minpercent** input variant call percentage, for example 20%, 5% or 1%

**--minbq** input minimum base nt quality, for example 25% or 30%

**--mindepth** input minimum depth of coverage for each nt base, for example 10

**--output-err** input name of output file for user troubleshooting or submit the error file for help

## (Optional)
fungshui marked this conversation as resolved.
Show resolved Hide resolved
**--input-prm** input primer FASTA file

**--output-name** input the desired output filename (default format: tsv)
fungshui marked this conversation as resolved.
Show resolved Hide resolved

**--input-region** input start and end positions; variant table will isolate variants within that region

**--stats** outputs a file containing genome statistics