Skip to content

Update README.md #2

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.

Sign up for GitHub

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

Open
Dedaniya08 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# VCF_TO_PLINK

The __vcf_to_plink.py__ script will convert Unphased vcf file to plink format and it is written in _Python3_. The converted file can be used in plink with --file option.


## Usage of the script
The program can be run using the following command\
```python vcf_to_plink.py -i <vcf_file_name> -o <plink_format_file_name>```\
To get the above help provide -h in the terminal\
```python vcf_to_plink.py -h```\

The program can be run using the following command

```python vcf_to_plink.py -i <vcf_file_name> -o <plink_format_file_name>```

To get the above help provide -h in the terminal

```python vcf_to_plink.py -h```

Two file names are required for the script to run successfully. Input file succeding '-i' is the vcf file name you want to convert. '-o' is the plink formatted output file name. Please don't add any extension after the file name such as '.vcf' or '.ped/.map'. These are all taken care by the script.