96
edits
Changes
From Genome Analysis Wiki
Jump to navigationJump to search→A. Convert dosage file into VCF format
For external users, follow the instruction at [[EPACTS]] page, summarized below.
For external users, follow the instruction at [[EPACTS]] page, summarized below.
*Download EPACTS binary at http://www.sph.umich.edu/csg/kang/epacts/download/epacts.v2.2.0.20121026.tar.gz (94MB)
*Please download the latest version of EPACTS here: http://csg.sph.umich.edu//kang/epacts/download/
*Uncompress EPACTS package to the directory you would like to install
*Uncompress EPACTS package to the directory you would like to install and then type the following commands
> tar xzvf EPACTS-3.0.0.tar.gz
> cd EPACTS-3.0.0
> ./configure --prefix [INSTALL DIRECTORY]
> make
> make install
*Perform a test run by running the following command
*Perform a test run by running the following command
EPACTS-3.0.0/example/test_run_epacts.sh
=== For Local Users in CSG ===
=== For Local Users in CSG ===
Once installed, test out the software by running a quick example using the test data provided in the "example" directory. The example VCF and PED files are:
Once installed, test out the software by running a quick example using the test data provided in the "example" directory. The example VCF and PED files are:
<pre>$ epacts.v2.2.0.20121026/example/1000G_exome_chr20_example_softFiltered.calls.vcf.gz
<pre>$ EPACTS-3.0.0/example/1000G_exome_chr20_example_softFiltered.calls.vcf.gz
$ epacts.v2.2.0.20121026/example/1000G_dummy_pheno.ped
$ EPACTS-3.0.0/example/1000G_dummy_pheno.ped
</pre>
</pre>
<br> Run the single variant score test on the example data using this command:
<br> Run the single variant score test on the example data using this command:
<pre>$ epacts.v2.2.0.20121026/epacts single
<pre>$ EPACTS-3.0.0/epacts single
--vcf epacts2.1/example/1000G_exome_chr20_example_softFiltered.calls.vcf.gz
--vcf epacts2.1/example/1000G_exome_chr20_example_softFiltered.calls.vcf.gz
--ped epacts2.1/example/1000G_dummy_pheno.ped
--ped epacts2.1/example/1000G_dummy_pheno.ped
This command will run the single variant test on the input VCF and PED files, with a minimum MAF threshold of 0.001. The phenotype is "DISEASE" and we are adjusting the analysis with covariates AGE and SEX. The output file directory prefix is {OUTPUT_DIR}/test. Finally, EPACTS will run the analysis in parallel on 2 CPUs.
This command will run the single variant test on the input VCF and PED files, with a minimum MAF threshold of 0.001. The phenotype is "DISEASE" and we are adjusting the analysis with covariates AGE and SEX. The output file directory prefix is {OUTPUT_DIR}/test. Finally, EPACTS will run the analysis in parallel on 2 CPUs.
A more detailed description of the example can be found [http://genome.sph.umich.edu/wiki/Test_EPACTS_for_DIAGRAM here].
A more detailed description of the example can be found [http://genome.sph.umich.edu/wiki/Test_EPACTS_for_DIAGRAM here].
== 2. Prepare VCF file with genotypes / dosages ==
== 2. Prepare VCF file with genotypes / dosages ==
=== A. Convert dosage file into VCF format ===
=== A. Convert dosage file into VCF format ===
Use the wrapper program "dose2vcf" to convert your doseage output to VCF format. Download the tool from [http://www.sph.umich.edu/csg/cfuchsb/dose2vcf_v0.4.tgz here]. If you used rs numbers during imputation, you can find mapping tables ready for dose2vcf [http://www.sph.umich.edu/csg/cfuchsb/mapping_rs_ALL.GIANT.phase1_release_v3.20101123.tgz here (214 Mb) ]
Use the wrapper program "dose2vcf" to convert your doseage output to pseudo VCF format. Download the tool from [http://csg.sph.umich.edu//cfuchsb/dose2vcf_v0.5.gz here]. If you used rs numbers during imputation, you can find mapping tables ready for dose2vcf [http://csg.sph.umich.edu//cfuchsb/mapping_rs_ALL.GIANT.phase1_release_v3.20101123.tgz here (214 Mb) ]
<br>
<br>
</pre>
</pre>
Note that for longer chromosomes, the program is quite memory intensive. In this case, please convert dosages in shorter sections of the chromosome. For example, if the imputation was performed by sections, then convert these sections to vcf first, and then merge the vcf files together using vcftools [http://vcftools.sourceforge.net/docs.html#concat vcf-concat]:
Note that for longer chromosomes, the program is quite memory intensive. In this case, please convert dosages in shorter sections of the chromosome. For example, if the imputation was performed by sections, then convert these sections to vcf first, and then merge the vcf files together using vcftools [http://vcftools.sourceforge.net/docs.html#concat vcf-concat]:
=== B. bgzip and tabix VCF files ===
=== B. bgzip and tabix VCF files ===
tabix -pvcf -f input.vcf.gz ## this command will produce input.vcf.gz.tbi
tabix -pvcf -f input.vcf.gz ## this command will produce input.vcf.gz.tbi
</pre>
</pre>
If the VCF file is separated by chromosome, the VCF file must contain the string "chr1" in the chromosome 1 file, and corresponding chromosome name for other chromosomes.<br>Sample IDs in the VCF file must be consistent to those from PED file
If the VCF file is separated by chromosome, the VCF file must contain the string "chr1" in the chromosome 1 file, and corresponding chromosome name for other chromosomes.<br>Sample IDs in the VCF file must be consistent to those from PED file
== 3. Prepare PED file for phenotypes and covariates ==
== 3. Prepare PED file for phenotypes and covariates ==
<pre>A DISEASE
<pre>A DISEASE
T QT
T QT
C AGE</pre>
C AGE</pre>
Key: A = binary trait; T = quantitative trait; C = covariate<br>
Key: A = binary trait; T = quantitative trait; C = covariate<br>
== 4. Run EPACTS association pipeline ==
== 4. Run EPACTS association pipeline ==
For detailed description of options, use:
For detailed description of options, use:
<pre>epacts.v2.2.0.20121026/epacts single -man
<pre>EPACTS-3.0.0/epacts single -man
</pre>
</pre>
<br>
<br>
=== Primary analyses (without BMI) [please submit as soon as the analysis is complete] ===
=== Primary analyses (without BMI) [please submit as soon as the analysis is complete] ===
There are '''2''' separate association analyses to be completed '''without adjusting for BMI'''.
There are '''2''' separate association analyses to be completed '''without adjusting for BMI'''.
<br>
<br>
<br>
<br>
=== Analysis for QC [please submit as soon as the analysis is complete] ===
=== Analysis for QC [please submit as soon as the analysis is complete] ===
For quality control, please run an additional analysis using EPACTS on all SNPs for chromosome 20 only using the '''SCORE''' test without BMI adjustment. These results will be used to compare with results from the primary analyses, to ensure the new EPACTS software has been run correctly.
For quality control, please run an additional analysis using EPACTS on all SNPs for chromosome 20 only using the '''SCORE''' test without BMI adjustment. These results will be used to compare with results from the primary analyses, to ensure the new EPACTS software has been run correctly.
|}
|}
<br>
<br>
=== Secondary analyses (with BMI) [please submit as soon as the analysis is complete] ===
=== Secondary analyses (with BMI) [please submit as soon as the analysis is complete] ===
There are '''2''' secondary analyses''' adjusting for BMI'''.
There are '''2''' secondary analyses''' adjusting for BMI'''.
=== A. Typical DIAGRAM analysis using existing association pipeline<br> ===
=== A. Typical DIAGRAM analysis using existing association pipeline<br> ===
This is the typical DIAGRAM analysis using your current association pipeline and software. [[Image:1000Genomes march2012 imputation analysis plan 08312012.pdf]]
This is the typical DIAGRAM analysis using your current association pipeline and software. [[Image:1000Genomes_march2012_imputation_analysis_plan_08312012_v2.pdf]] (Updated Dec 14, 2012)
For frequently asked questions regarding the file format, please see: [http://genome.sph.umich.edu/wiki/EPACTS_for_DIAGRAM#Results_FIle_Clarifications genome.sph.umich.edu/wiki/EPACTS_for_DIAGRAM#Results_FIle_Clarifications]
==== Alternative: Analyze VCF and PED files using the Wald test with the EPACTS software: ====
==== Alternative: Analyze VCF and PED files using the Wald test with the EPACTS software: ====
As preparation for the Firth test analysis, we encourage you to analyze the data using the Wald test first, since it is computationally faster. This will be a good way to check if your VCF and PED files are correctly formatted for EPACTS and resolve any problems you may have with your imputation or input files.
As preparation for the Firth test analysis, we encourage you to analyze the data using the Wald test first, since it is computationally much faster. This will be a good way to check if your VCF and PED files for every chromosome are correctly formatted for EPACTS and resolve any problems you may have with your imputation or input files.
<pre>epacts.v2.2.0.20121026 /epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
<pre>EPACTS-3.0.0/epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
-test b.wald -pheno DISEASE -cov AGE -sepchr -anno -min-mac 1 -field EC -run 10
-test b.wald -pheno DISEASE -cov AGE -sepchr -anno -min-mac 1 -field EC -run 10
</pre>
</pre>
'''Important:''' To analyze dosages (not genotypes), you must specify the dosage field with the "--field EC" option. Without this option, you will be analyzing the hard genotypes (i.e. --field option defaults to "GT" or "genotypes")!
'''Important:''' To analyze dosages (not genotypes), you must specify the dosage field with the "--field EC" option. Without this option, you will be analyzing the hard genotypes (i.e. --field option defaults to "GT" or "genotypes")!
=== B. Analysis of low frequency variants using Firth bias-corrected logistic regression ===
=== B. Analysis of low frequency variants using Firth bias-corrected logistic regression ===
To run the Firth test using the EPACTS software:
To run the Firth test using the EPACTS software:
<pre>epacts.v2.2.0.20121026 /epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
<pre>EPACTS-3.0.0/epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
-test b.firth -pheno DISEASE -cov AGE -sepchr -anno -min-mac 1 -max-mac 200 -field EC -run 10
-test b.firth -pheno DISEASE -cov AGE -sepchr -anno -min-mac 1 -max-mac 200 -field EC -run 10
</pre>
</pre>
The EPACTS command for the score test analysis of chromosome 20 is:
The EPACTS command for the score test analysis of chromosome 20 is:
<pre>epacts.v2.2.0.20121026 /epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
<pre>EPACTS-3.0.0/epacts single -vcf [INPUT VCF FILENAME] -ped [INPUT PED FILENAME] -out [OUTPUT FILENAME PREFIX] \
-test b.score -pheno DISEASE -cov AGE -chr 20 -anno -min-mac 1 -field EC -run 10
-test b.score -pheno DISEASE -cov AGE -chr 20 -anno -min-mac 1 -field EC -run 10
</pre>
</pre>
=== D. Typical DIAGRAM analysis using existing association pipeline (with BMI)<br> ===
=== D. Typical DIAGRAM analysis using existing association pipeline (with BMI)<br> ===
This is the typical DIAGRAM analysis using your current association pipeline and software including BMI adjustment.
This is the typical DIAGRAM analysis using your current association pipeline and software including BMI adjustment.
'''Alternative: Analyze VCF and PED files using the Wald test with the EPACTS software:'''
'''Alternative: Analyze VCF and PED files using the Wald test with the EPACTS software:'''
<br>
<br>
=== E. Analysis of low frequency variants using Firth bias-corrected logistic regression (with BMI) ===
=== E. Analysis of low frequency variants using Firth bias-corrected logistic regression (with BMI) ===
Again use the Firth test on EPACTS for your analysis with BMI
Again use the Firth test on EPACTS for your analysis with BMI
== 5. Report results<br> ==
For '''analysis 1''', please follow the following results file guidelines: [[Image:1000Genomes_march2012_imputation_analysis_plan_08312012_v2.pdf]] (Updated Dec 14, 2012)
For frequently asked questions regarding the file format, please see: [http://genome.sph.umich.edu/wiki/EPACTS_for_DIAGRAM#Results_FIle_Clarifications genome.sph.umich.edu/wiki/EPACTS_for_DIAGRAM#Results_FIle_Clarifications]
For analyses 2 and 3, please upload the two epacts.gz files to the FTP server:
For '''analyses 2 and 3''', please upload the two epacts.gz files to the FTP server:
#'''Firth test (no BMI): ''' DIAGRAMv4_iSNPs_XXX_1000G_KKK_FBC_YYY_ZZZ.epacts.gz
#'''Firth test (no BMI): ''' DIAGRAMv4_iSNPs_XXX_1000G_KKK_FBC_YYY_ZZZ.epacts.gz
<br>
<br>
The FTP hostname is: '''ftp.broadinstitute.org'''. Please place your files into to the /incoming/ directory.
Here's an example score test .epacts file
Here's an example score test .epacts file
= Troubleshooting Common Issues =
= Troubleshooting Common Issues =
== EPACTS installation errors ==
== EPACTS installation errors ==
== Errors when running EPACTS ==
== Errors when running EPACTS ==
=== Rscript execution error: No such file or directory ===
=== Rscript execution error: No such file or directory ===
If you can find Rscript (e.g. /usr/bin/Rscript, /usr/local/bin/Rscript), or if you can re-install the full Rscript, you can simply avoid the problem by setting your environment variable.
If you can find Rscript (e.g. /usr/bin/Rscript, /usr/local/bin/Rscript), or if you can re-install the full Rscript, you can simply avoid the problem by setting your environment variable.
Otherwise, Hyun will modify EPACTS to not requiring this (so you can run R CMD BATCH instead of Rscript).
Otherwise, Hyun will modify EPACTS to not requiring this (so you can run R CMD BATCH instead of Rscript).
=== ERROR: No overlapping IDs between VCF and PED file. Cannot proceed. ===
=== ERROR: No overlapping IDs between VCF and PED file. Cannot proceed. ===
</pre>
</pre>
<br> The genotype information has FORMAT "GT:EC". For the first SNP (chr11:180567) and individual A001, the genotype is 1/1 and dosage is 2.0000. To access the dosages, you must specify the option "-field EC"
<br> The genotype information has FORMAT "GT:EC". For the first SNP (chr11:180567) and individual A001, the genotype is 1/1 and dosage is 2.0000. To access the dosages, you must specify the option "-field EC".
== Results FIle Clarifications ==
=== 1. How do I code the INDEL variant names and alleles? ===
Please use the variant name and the allele name directly from IMPUTE or minimac. Please do NOT recode variant names or alleles. We will do this step in the analysis for consistency.
ACTION IF YOU HAVE UPLOADED YOUR FILE: If you have recoded your INDEL alleles, please tell us so we can remove your file and let us know when you can reupload with the original variable and allele names.
=== <br>2. The document asks for the number of homozygotes and heterozygotes in case and control. How do I get this from my data? Is this relevant for imputed data? ===
These numbers were relevant to genotyped data but not for imputed data. We didn't intend to ask for this. To retain the same file format between results already submitted and those to be submitted please retain the columns with a "." for the value.
ACTION IF YOU HAVE UPLOADED YOUR FILE: No action. You do not need to redo the file. We will skip these columns.
=== 3. For the "Imputed" variable, what does imputed mean in the context of the data output from MACH and IMPUTE? ===
This is a hold over from the last round of analysis where we asked for results separately from genotyped SNPs and imputed SNPs and wanted to distinguish between the two. We will use r2_hat or info measures to estimate the accuracy of the genotypes. This column will be retained for consistency with files already submitted but should be filled in with "." or "1". It will not be used in the analysis.
ACTION IF YOU HAVE UPLOADED YOUR FILE: No action. You do not need to redo the file. We will skip this column.
