Difference between revisions of "Minimac3"

From Genome Analysis Wiki
Jump to navigationJump to search
(43 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Download New Version 1.0.12 !!! (Updated Sep 2015) !!!'''
+
 
 +
* '''Introducing [[DosageConvertor|DosageConvertor]], a tool to convert imputed data in VCF format to other formats, such as MaCH or PLINK. '''
 +
 
 +
* '''Updated descriptors on [[Minimac3 Info File| Minimac3 Info File]] with better explanation of terms.'''
 +
 
 +
* '''Please join our NEW [https://groups.google.com/forum/embed/?place=forum/minimac4-help#!forum/minimac4-help mailing list] to get updates about future releases, bug fixes or post queries.'''
 +
 
 +
* '''Download New Version 2.0.1 !!! (Updated June 2016) !!!''' See [[Minimac3 ChangeLog | ChangeLog ]] for details !!!
  
 
= Useful Wiki Pages =
 
= Useful Wiki Pages =
Line 14: Line 21:
  
 
* [[Minimac3 Examples| Minimac3 Examples]]
 
* [[Minimac3 Examples| Minimac3 Examples]]
 +
 +
* [[Minimac3 Info File| Minimac3 Info File]]
  
 
* [[Minimac3 ChangeLog | Minimac3 ChangeLog ]]
 
* [[Minimac3 ChangeLog | Minimac3 ChangeLog ]]
Line 27: Line 36:
 
= Download =
 
= Download =
  
'''Minimac3 ''' is currently available as a release version. Commonly used reference panels in <font face=Courier>M3VCF</font> format are available for download in [[#Reference Panels for Download | Reference Panels]]. The authors would really appreciate if users report possible bugs by e-mailing [mailto:sayantan@umich.edu Sayantan Das].
+
'''Minimac3 ''' is currently available as a release version. Commonly used reference panels in <font face=Courier>M3VCF</font> format are available for download in [[#Reference Panels for Download | Reference Panels]].  
  
'''VERSION: 1.0.12 !!! (Updated 9.5.2015) !!!'''
+
'''Please join our NEW [https://groups.google.com/forum/embed/?place=forum/minimac4-help#!forum/minimac4-help mailing list] to get updates about future releases or report possible bugs or email them to  [mailto:sayantan@umich.edu Sayantan Das].'''
 +
 
 +
'''VERSION: 2.0.1 !!! (Updated 6.6.2016) !!!'''
  
 
'''Github Repo:''' Users can clone from github repository as well : [https://github.com/Santy-8128/Minimac3 Minimac3 Github]  
 
'''Github Repo:''' Users can clone from github repository as well : [https://github.com/Santy-8128/Minimac3 Minimac3 Github]  
Line 40: Line 51:
 
! Download Link
 
! Download Link
 
|-  
 
|-  
| Minimac3 Source Files  
+
| Source Files  
| [ftp://share.sph.umich.edu/minimac3/Minimac3.v1.0.12.tar.gz UNIX Users ]
+
| [ftp://share.sph.umich.edu/minimac3/Minimac3.v2.0.1.tar.gz UNIX Users ]
 +
|-
 +
| Binary Executable <sup>&#8224;</sup>
 +
| [ftp://share.sph.umich.edu/minimac3/Minimac3Executable.tar.gz UNIX Users ]
 +
|}
  
|}
+
'''<sup>&#8224;</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 else contact the author [mailto:sayantan@umich.edu Sayantan Das]..
  
 
= Usage=
 
= Usage=
Line 49: Line 64:
 
Users should follow the following steps to compile '''Minimac3''' (if they downloaded the source files) or should skip them (if they downloaded the binary executable).
 
Users should follow the following steps to compile '''Minimac3''' (if they downloaded the source files) or should skip them (if they downloaded the binary executable).
  
  ## EXTRACT MINIMAC3 AND COMPILE
+
  ## DOWNLOAD, EXTRACT MINIMAC3 AND COMPILE
 
  &nbsp;
 
  &nbsp;
  tar -xzvf Minimac3.v1.0.12.tar.gz
+
wget ftp://share.sph.umich.edu/minimac3/Minimac3.v2.0.1.tar.gz
 +
  tar -xzvf Minimac3.v2.0.1.tar.gz
 
  cd Minimac3/
 
  cd Minimac3/
 
  make
 
  make
Line 70: Line 86:
  
 
Some commonly used reference panels are available for download here:
 
Some commonly used reference panels are available for download here:
 +
 +
'''Chr X Haplotypes for 1000 Genomes Phase 3 have been updated on Oct 20 to include multi-allelic variants as well (split as bi-allelic variants) !!!'''
  
 
{| class="wikitable" style="text-align:center" border="1" cellpadding="2"
 
{| class="wikitable" style="text-align:center" border="1" cellpadding="2"
Line 126: Line 144:
 
|  [ftp://share.sph.umich.edu/minimac3/G1K_P1_CHR_X_VCF_M3VCF_FILES.tar.gz Download] <!--[ftp://share.sph.umich.edu/minimac3/G1K_P1_CHR_X_VCF_M3VCF_FILES.tar.gz Download]-->
 
|  [ftp://share.sph.umich.edu/minimac3/G1K_P1_CHR_X_VCF_M3VCF_FILES.tar.gz Download] <!--[ftp://share.sph.umich.edu/minimac3/G1K_P1_CHR_X_VCF_M3VCF_FILES.tar.gz Download]-->
 
|}
 
|}
 +
 +
= Reference =
 +
 +
If you use [[minimac3]] please cite:
 +
 +
''Das S, Forer L, Schönherr S, Sidore C, Locke AE'' et al. Next-generation genotype imputation service and methods. Nature Genetics 2016; 48, 1284–1287 (2016) doi:10.1038/ng.3656[http://www.nature.com/ng/journal/v48/n10/full/ng.3656.html]
  
 
= Contact =
 
= Contact =
  
 
In case of any queries and bugs please contact [mailto:sayantan@umich.edu Sayantan Das].
 
In case of any queries and bugs please contact [mailto:sayantan@umich.edu Sayantan Das].

Revision as of 21:19, 18 December 2016

  • Introducing DosageConvertor, a tool to convert imputed data in VCF format to other formats, such as MaCH or PLINK.
  • Please join our NEW mailing list to get updates about future releases, bug fixes or post queries.
  • Download New Version 2.0.1 !!! (Updated June 2016) !!! See ChangeLog for details !!!

Useful Wiki Pages

There are a few pages in this Wiki that may be useful to for Minimac3 users. Here are links to a few:

Introduction

Minimac3 is a lower memory and more computationally efficient implementation of the genotype imputation algorithms in minimac and minimac2. Minimac3 is designed to handle very large reference panels in a more computationally efficient way with no loss of accuracy. It accomplishes this by identifying repeat haplotype patterns and using these to simplify the underlying calculations, with no loss of accuracy.

Minimac3 uses M3VCF files (customized minimac3 VCF files) to store reference panel information in a compact form, thus saving on memory and time required to read large datasets. Users can use Minimac3 to convert standard VCF files to M3VCF files. M3VCF files can also store pre-calculated estimates of recombination fraction and error, which speeds up later rounds of imputation. Minimac3 outputs results in the form of standard VCF files for easy data manipulation in downstream analysis.

Download

Minimac3 is currently available as a release version. Commonly used reference panels in M3VCF format are available for download in Reference Panels.

Please join our NEW mailing list to get updates about future releases or report possible bugs or email them to Sayantan Das.

VERSION: 2.0.1 !!! (Updated 6.6.2016) !!!

Github Repo: Users can clone from github repository as well : Minimac3 Github

Cloning from GitHub is recommened so that updates can be easily pulled back !!!

Description Download Link
Source Files UNIX Users
Binary Executable UNIX Users

Binary executables are NOT guaranteed to run on every LINUX machine. Please compile from source files if you have trouble with the executable, or else contact the author Sayantan Das..

Usage

Users should follow the following steps to compile Minimac3 (if they downloaded the source files) or should skip them (if they downloaded the binary executable).

## DOWNLOAD, EXTRACT MINIMAC3 AND COMPILE
 
wget ftp://share.sph.umich.edu/minimac3/Minimac3.v2.0.1.tar.gz
tar -xzvf Minimac3.v2.0.1.tar.gz
cd Minimac3/
make

A typical Minimac3 command line for imputation is as follows

../bin/Minimac3 --refHaps refPanel.vcf \ 
                --haps targetStudy.vcf \
                --prefix testRun

Here refPanel.vcf is the reference panel used in VCF format (e.g. 1000 Genomes), targetStudy.vcf is the phased GWAS data in VCF format, and testRun is the prefix for the output files. Some commonly used reference panels are available for download in Reference Panels. See wiki page on Detailed Usage and Imputation Cookbook for further details on using Minimac3 for imputation analysis.

Users can always type the following for further support:

 /bin/Minimac3 --help

Reference Panels for Download

Some commonly used reference panels are available for download here:

Chr X Haplotypes for 1000 Genomes Phase 3 have been updated on Oct 20 to include multi-allelic variants as well (split as bi-allelic variants) !!!

Reference Panel Number
of Samples
File Format Parameter
Estimates
Available
Chromosomes Link
1000 Genomes

Phase 3
(version 5)

2,504 VCF - 1-22,X Download
M3VCF YES 1-22,X Download
NO 1-22,X Download
VCF,M3VCF YES X Download
1000 Genomes

Phase 1
(version 3)

1,092 VCF - 1-22,X Download
M3VCF YES 1-22,X Download
NO 1-22,X Download
VCF,M3VCF YES X Download

Reference

If you use minimac3 please cite:

Das S, Forer L, Schönherr S, Sidore C, Locke AE et al. Next-generation genotype imputation service and methods. Nature Genetics 2016; 48, 1284–1287 (2016) doi:10.1038/ng.3656[1]

Contact

In case of any queries and bugs please contact Sayantan Das.