Skip to content

Commit 9dac455

Browse files
committed
Update README.md
1 parent 37e82e2 commit 9dac455

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

examples/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,37 @@ python ./src/PrecisionProDB.py \
143143
-S precisionprodb/GCF_009914755.1_T2T-CHM13v2.0.sqlite
144144
```
145145

146+
# vcf2mutation
147+
to get tsv file from the vcf file, you can use the vcf2mutation.py script
148+
```
149+
cd $PATH_OF_PRECISONPRODB
150+
python ./src/vcf2mutation.py -h
151+
152+
usage: vcf2mutation [-h] -i FILE_VCF [-o OUTPREFIX] [-s SAMPLE]
153+
[-F] [-A]
154+
155+
convert extract mutation information from vcf file
156+
157+
options:
158+
-h, --help show this help message and exit
159+
-i FILE_VCF, --file_vcf FILE_VCF
160+
input vcf file. It can be a gzip file
161+
-o OUTPREFIX, --outprefix OUTPREFIX
162+
output prefix to store the two output
163+
dataframes, default: None, do not write
164+
the result to files. file will be
165+
outprefix_1/2.tsv
166+
-s SAMPLE, --sample SAMPLE
167+
sample name in the vcf to extract the
168+
variant information. default: None,
169+
extract the first sample
170+
-F, --no_filter default only keep variant with value
171+
"PASS" FILTER column of vcf file. if
172+
set, do not filter
173+
-A, --all_chromosomes
174+
default keep variant in chromosomes and
175+
ignore those in short fragments of the
176+
genome. if set, use all chromosomes
177+
including fragments
178+
179+
```

0 commit comments

Comments
 (0)