# vcf2maf_lite
vcf2maf_lite is a lightweight Python adaptation of the [vcf2maf Perl tool](https://github.com/mskcc/vcf2maf), designed to convert the VCF format to MAF format without adding variant annotations. For annotating a MAF file, [Genome Nexus](https://github.com/genome-nexus/genome-nexus-annotation-pipeline) can be utilized.
### Installation using pip
```
pip3 install vcf2maf_lite
```
Usage:
```
vcf2maf_lite --help
Usage: vcf2maf_lite [OPTIONS]
Options:
-i, --input-data TEXT A list of .vcf files or input data directories,
separated by commas [required]
-o, --output-directory TEXT output data directory [optional]
-c, --center TEXT name of center (standard MAF field = 'Center')
[optional]
-s, --sequence-source TEXT Sequencing source (standard MAF field =
'Sequencing_Source'), e.g., WXS or WGS
[optional]
-t, --tumor-id TEXT The ID of the tumor sample utilized in the
genotype columns of the VCF file. [optional]
-n, --normal-id TEXT The ID of the normal sample utilized in the
genotype columns of the VCF file. [optional]
-a, --retain-info TEXT Comma-delimited names of INFO fields to retain
as extra columns in MAF [optional]
-f, --retain-fmt TEXT Comma-delimited names of FORMAT fields to
retain as extra columns in MAF [optional]
--help Show this message and exit.
```
Example Usage:
```
vcf2maf_lite --input-data /data/vcf --output-directory /data/maf/ --center CTR --sequence-source WGS --tumor-id Tumor --normal-id Normal --retain-info Custom_filters,AC,AF,AC_nfe_seu,AC_afr,AF_afr --retain-fmt alt_count_raw,ref_count_raw,depth_raw
```
This command converts the VCF files in /vcf folder to MAF format.
- The `--input-data` option is used to specify either a single VCF file or a directory containing multiple VCF files (separated by commas). This option supports passing multiple input files or directories at once.
- The `--output-directory` option allows you to specify the directory where the MAF files will be saved. If no output path is provided, the default output directory `vcf2maf_output` will be used in the current working directory.
- The `--tumor-id` option allows you to specify the ID of the tumor sample used in the genotype columns of the VCF file. If the option is not used, the script will automatically identify the tumor ID from either the `tumor_sample` keyword in the meta data lines or the sample columns from VCF header.
- The `--normal-id` option allows you to specify the ID of the normal sample used in the genotype columns of the VCF file. If the option is not used, the script will automatically identify the normal ID from either the `normal_sample` keyword in the meta data lines or the sample columns from VCF header.
- The `--retain-info` option allows you to specify the INFO fields to be retained as additional columns in the MAF. If the option is not used, standard MAF columns are included by default.
- The `--retain-fmt` option allows you to specify the FORMAT fields to be retained as additional columns in the MAF. If the option is not used, standard MAF columns are included by default.
Importing to Python Scripts:
```
from vcf2maf_lite.vcf2maf_lite import main
from click.testing import CliRunner
runner = CliRunner()
runner.invoke(main, ['--input-data','test_vcf.vcf'])
```
Raw data
{
"_id": null,
"home_page": "https://github.com/genome-nexus/vcf2maf-lite",
"name": "vcf2maf-lite",
"maintainer": "Ramya Madupuri",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "vcf2maf, vcftomaf, vcf, maf, lite",
"author": "Angelica Ochoa",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/68/bc/a46dd228ced766a492713370a0415ee6293edf0919c0c65b26efda95c6cf/vcf2maf_lite-0.1.1.tar.gz",
"platform": null,
"description": "# vcf2maf_lite\n\nvcf2maf_lite is a lightweight Python adaptation of the [vcf2maf Perl tool](https://github.com/mskcc/vcf2maf), designed to convert the VCF format to MAF format without adding variant annotations. For annotating a MAF file, [Genome Nexus](https://github.com/genome-nexus/genome-nexus-annotation-pipeline) can be utilized.\n\n### Installation using pip\n\n```\npip3 install vcf2maf_lite\n```\n\nUsage:\n\n```\nvcf2maf_lite --help\n\nUsage: vcf2maf_lite [OPTIONS]\n\nOptions:\n -i, --input-data TEXT A list of .vcf files or input data directories,\n separated by commas [required]\n -o, --output-directory TEXT output data directory [optional]\n -c, --center TEXT name of center (standard MAF field = 'Center')\n [optional]\n -s, --sequence-source TEXT Sequencing source (standard MAF field =\n 'Sequencing_Source'), e.g., WXS or WGS\n [optional]\n -t, --tumor-id TEXT The ID of the tumor sample utilized in the\n genotype columns of the VCF file. [optional]\n -n, --normal-id TEXT The ID of the normal sample utilized in the\n genotype columns of the VCF file. [optional]\n -a, --retain-info TEXT Comma-delimited names of INFO fields to retain\n as extra columns in MAF [optional]\n -f, --retain-fmt TEXT Comma-delimited names of FORMAT fields to\n retain as extra columns in MAF [optional]\n --help Show this message and exit.\n```\n\nExample Usage:\n```\nvcf2maf_lite --input-data /data/vcf --output-directory /data/maf/ --center CTR --sequence-source WGS --tumor-id Tumor --normal-id Normal --retain-info Custom_filters,AC,AF,AC_nfe_seu,AC_afr,AF_afr --retain-fmt alt_count_raw,ref_count_raw,depth_raw\n```\n\nThis command converts the VCF files in /vcf folder to MAF format. \n- The `--input-data` option is used to specify either a single VCF file or a directory containing multiple VCF files (separated by commas). This option supports passing multiple input files or directories at once.\n- The `--output-directory` option allows you to specify the directory where the MAF files will be saved. If no output path is provided, the default output directory `vcf2maf_output` will be used in the current working directory. \n- The `--tumor-id` option allows you to specify the ID of the tumor sample used in the genotype columns of the VCF file. If the option is not used, the script will automatically identify the tumor ID from either the `tumor_sample` keyword in the meta data lines or the sample columns from VCF header.\n- The `--normal-id` option allows you to specify the ID of the normal sample used in the genotype columns of the VCF file. If the option is not used, the script will automatically identify the normal ID from either the `normal_sample` keyword in the meta data lines or the sample columns from VCF header.\n- The `--retain-info` option allows you to specify the INFO fields to be retained as additional columns in the MAF. If the option is not used, standard MAF columns are included by default.\n- The `--retain-fmt` option allows you to specify the FORMAT fields to be retained as additional columns in the MAF. If the option is not used, standard MAF columns are included by default.\n\n\nImporting to Python Scripts:\n```\nfrom vcf2maf_lite.vcf2maf_lite import main\nfrom click.testing import CliRunner\n\nrunner = CliRunner()\nrunner.invoke(main, ['--input-data','test_vcf.vcf'])\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "VCF to MAF format converter",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/genome-nexus/vcf2maf-lite/issues",
"Homepage": "https://github.com/genome-nexus/vcf2maf-lite",
"Repository": "https://github.com/genome-nexus/vcf2maf-lite"
},
"split_keywords": [
"vcf2maf",
" vcftomaf",
" vcf",
" maf",
" lite"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6afbdb1bd7b0b6f7e586c8feed7f5099317438eaf8a31f137a2e5a091448895",
"md5": "e9025a7de227c553e16451ba3824f761",
"sha256": "79ed99e0285dda9fe039a3b5a7572ff4d3987576a75fe7c6a4dd2ea41e2f8e38"
},
"downloads": -1,
"filename": "vcf2maf_lite-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9025a7de227c553e16451ba3824f761",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18178,
"upload_time": "2024-07-30T21:38:58",
"upload_time_iso_8601": "2024-07-30T21:38:58.144089Z",
"url": "https://files.pythonhosted.org/packages/f6/af/bdb1bd7b0b6f7e586c8feed7f5099317438eaf8a31f137a2e5a091448895/vcf2maf_lite-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "68bca46dd228ced766a492713370a0415ee6293edf0919c0c65b26efda95c6cf",
"md5": "ab7eb1315de735e292d221e8c6859955",
"sha256": "105aa4fa45e3585f72e92cf6a3d905c06b34d3744bace407ab870869badc045a"
},
"downloads": -1,
"filename": "vcf2maf_lite-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ab7eb1315de735e292d221e8c6859955",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18283,
"upload_time": "2024-07-30T21:38:59",
"upload_time_iso_8601": "2024-07-30T21:38:59.130699Z",
"url": "https://files.pythonhosted.org/packages/68/bc/a46dd228ced766a492713370a0415ee6293edf0919c0c65b26efda95c6cf/vcf2maf_lite-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 21:38:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "genome-nexus",
"github_project": "vcf2maf-lite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vcf2maf-lite"
}
JSON
