DosageConvertor - Revision history

Santy.8128 at 18:01, 18 January 2019

2019-01-18T18:01:55Z

← Older revision		Revision as of 14:01, 18 January 2019
Line 4:		Line 4:
	= Introduction =		= Introduction =
	DosageConvertor is a C++ tool to convert dosage files (in VCF format) from [[Minimac4\| Minimac3/4]] to other formats such as MaCH or PLINK.		DosageConvertor is a C++ tool to convert dosage files (in VCF format) from [[Minimac4\| Minimac3/4]] to other formats such as MaCH or PLINK.

			[Please note that this tool CANNOT handle missing values in the input files and may NOT work appropriately for non-Minimac3/4 VCF files]


	= Download =		= Download =

Santy.8128: /* Installation */

2018-06-22T16:39:42Z

Installation

← Older revision		Revision as of 12:39, 22 June 2018
Line 29:		Line 29:

	git clone https://github.com/Santy-8128/DosageConvertor		git clone https://github.com/Santy-8128/DosageConvertor
	cd DosageConvertor/		cd DosageConvertor/
	make		make

Santy.8128: /* Installation */

2018-06-22T16:39:25Z

Installation

← Older revision		Revision as of 12:39, 22 June 2018
Line 28:		Line 28:
	## EXTRACT M3VCFTOOLS AND COMPILE		## EXTRACT M3VCFTOOLS AND COMPILE

	~~wget ftp~~://~~share~~.~~sph.umich.edu~~/~~minimac3~~/DosageConvertor~~/DosageConvertor.v1.0.4.tar.gz~~		git clone https://github.com/Santy-8128/DosageConvertor
	~~tar -xzvf DosageConvertor.v1.0.4.tar.gz~~		cd DosageConvertor/
	cd DosageConvertor/
	make		make

Santy.8128: /* Download */

2018-06-22T16:38:51Z

Download

← Older revision		Revision as of 12:38, 22 June 2018
Line 19:		Line 19:
	\|		\|
	[https://github.com/Santy-8128/DosageConvertor DosageConvertor - Github]		[https://github.com/Santy-8128/DosageConvertor DosageConvertor - Github]
	\|-
	~~\| Source Files~~
	\|
	~~[ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertor.v1.0.4.tar.gz UNIX Users ]~~
	\|-
	~~\| Binary Executable <sup>†</sup>~~
	~~(Ubuntu 4.8.4)~~
	\|
	~~[ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertorExecutable.tar.gz UNIX Users ]~~

	\|}		\|}

	'''<sup>†</sup>''' Binary executables are NOT guaranteed to run on every LINUX machine. Please compile from source files if you have trouble with the executable, or clone from the [https://github.com/Santy-8128/DosageConvertor github repository]. Else contact the author [mailto:sayantan@umich.edu Sayantan Das].

	= Installation =		= Installation =

Santy.8128: /* Convert to MaCH Files */

2017-07-12T05:47:07Z

Convert to MaCH Files

← Older revision		Revision as of 01:47, 12 July 2017
Line 59:		Line 59:
	== Convert to MaCH Files ==		== Convert to MaCH Files ==

	The following command will convert an input VCF dosage file to a MaCH/minimac dosage file (the format for previous versions of [[Minimac \| minimac]]). The generated dosage files can be tested for association using [http://genome.sph.umich.edu/wiki/Mach2dat:_Association_with_MACH_output mach2dat].		The following command will convert an input VCF dosage file to a MaCH/minimac dosage file (the format for previous versions of [[Minimac \| minimac]]). The generated dosage files can be tested for association using tools like [http://genome.sph.umich.edu/wiki/Mach2dat:_Association_with_MACH_output mach2dat] or [http://www.genabel.org/packages/ProbABEL ProbABEL].

	./DosageConvertor --vcfDose TestDataImputedVCF.dose.vcf.gz		./DosageConvertor --vcfDose TestDataImputedVCF.dose.vcf.gz

Santy.8128 at 05:34, 12 July 2017

2017-07-12T05:34:41Z

← Older revision		Revision as of 01:34, 12 July 2017
Line 22:		Line 22:
	\| Source Files		\| Source Files
	\|		\|
	[ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertor.v1.0.3.tar.gz UNIX Users ]		[ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertor.v1.0.4.tar.gz UNIX Users ]
	\|-		\|-
	\| Binary Executable <sup>†</sup>		\| Binary Executable <sup>†</sup>
Line 39:		Line 39:
	## EXTRACT M3VCFTOOLS AND COMPILE		## EXTRACT M3VCFTOOLS AND COMPILE

	wget ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertor.v1.0.3.tar.gz		wget ftp://share.sph.umich.edu/minimac3/DosageConvertor/DosageConvertor.v1.0.4.tar.gz
	tar -xzvf DosageConvertor.v1.0.3.tar.gz		tar -xzvf DosageConvertor.v1.0.4.tar.gz
	cd DosageConvertor/		cd DosageConvertor/
	make		make

Santy.8128: /* Command Line Options */

2017-07-12T05:14:44Z

Command Line Options

← Older revision		Revision as of 01:14, 12 July 2017
Line 153:		Line 153:
	\| <code>--trimNames</code>		\| <code>--trimNames</code>
	\|		\|
	indicates whether to trim ~~alleles and~~ variants IDs to 100 characters		indicates whether to trim variants IDs to 100 characters

	Since PLINK does not allow variant IDs longer than 16,000 characters, this option can be used if variant names are too long.		Since PLINK does not allow variant IDs longer than 16,000 characters, this option can be used if variant names are too long.
Line 159:		Line 159:
	\| <code>--trimLength</code>		\| <code>--trimLength</code>
	\|		\|
			number (<16000) indicating the length to which to trim variants IDs to (default value : 100)
	\|}		\|}

Santy.8128: /* Command Line Options */

2017-07-12T05:13:27Z

Command Line Options

← Older revision		Revision as of 01:13, 12 July 2017
Line 115:		Line 115:
	\| <code>--tag</code>		\| <code>--tag</code>
	\|		\|
	indicates the FORMAT tag of the VCF from which to import the imputed dosages:		indicates the FORMAT tag of the VCF file from which to import the imputed dosages:
	*<code>DS</code>: imputed values from dosages (default)		*<code>DS</code>: imputed values from dosages (default)
	*<code>GP</code>: genotype probabilities		*<code>GP</code>: genotype probabilities
Line 151:		Line 151:
	*the second columns contains either M (for males) or F (for females)		*the second columns contains either M (for males) or F (for females)
	\|-		\|-
	\| <code>--~~TrimAlleles~~</code>		\| <code>--trimNames</code>
	\|		\|
	indicates whether to trim alleles and variants IDs to 100 characters		indicates whether to trim alleles and variants IDs to 100 characters

	Since PLINK does not allow variant IDs longer than 16,000 characters, this option can be used if variant names are too long.		Since PLINK does not allow variant IDs longer than 16,000 characters, this option can be used if variant names are too long.
			\|-
			\| <code>--trimLength</code>
			\|
	\|}		\|}

Santy.8128: /* Command Line Options */

2017-07-12T04:51:31Z

Command Line Options

← Older revision		Revision as of 00:51, 12 July 2017
Line 115:		Line 115:
	\| <code>--tag</code>		\| <code>--tag</code>
	\|		\|
	indicates the ~~genotype information~~ to import ~~from~~ the ~~input VCF file~~:		indicates the FORMAT tag of the VCF from which to import the imputed dosages:
	*<code>DS</code>: imputed values from dosages (default)		*<code>DS</code>: imputed values from dosages (default)
	*<code>GP</code>: genotype probabilities		*<code>GP</code>: genotype probabilities

Santy.8128: /* Converting Chromosome X Files */

2017-07-12T04:50:28Z

Converting Chromosome X Files

← Older revision		Revision as of 00:50, 12 July 2017
Line 76:		Line 76:
	== Converting Chromosome X Files ==		== Converting Chromosome X Files ==

	For a minimac3/4 ~~output file containing the pseudo-autosomal region (PAR) on chromosome X, no extra parameter is necessary. For files containing the non-PAR region~~, please ensure the following:		For conversion of X chromosome files from minimac3/4, please ensure the following:

	* If your input VCF dosage file has '''males as diploids''', then just add handle <code>--allDiploid</code>. This will NOT generate sex information in the output PLINK <code>.fam</code> file. ~~You would have~~ to ~~update it manually~~.		* If your input VCF dosage file has '''males as diploids''', then just add handle <code>--allDiploid</code>. This will NOT generate sex information in the output PLINK <code>.fam</code> file.
	* If your input VCF dosage file has '''males as haploids''' and '''also has GT information''', the tool with automatically determine the sex of the samples and report them in the output <code>.fam</code> file. No extra parameters are required.		** If you still need the sex column in <code>.fam</code> file to be correctly updated, then supply a sex file using <code>--sexFile SomeFile</code> where <code>SomeFile</code> has two columns:
	** If GT tags are NOT available, you would need to supply the ~~sex file~~ as described ~~in the section below~~. Otherwise it will throw an error.		*** the first column has the sample names as found in the VCF file
	** '''NOTE''': If your VCF file has males as haploids, do NOT use <code>--allDiploid</code> as the code would NOT throw any error~~, but the output results would be erroneous.~~		*** the second columns has M (for males) or F (for females).
			* If your input VCF dosage file has '''males as haploids''' and '''also has GT information''', the tool with automatically determine the sex of the samples from their ploidy and report them in the output <code>.fam</code> file. No extra parameters are required.
			** If '''GT''' tags are NOT available, you would need to supply the <code>--sexFile</code> as described above. Otherwise it will throw an error.
			** '''NOTE''': If your VCF file has males as haploids, do NOT use <code>--allDiploid</code> as the output results would be erroneous (although the code would NOT throw any error)

	= Command Line Options =		= Command Line Options =