Difference between revisions of "Minimac3 - Full List of Options"

From Genome Analysis Wiki
Jump to: navigation, search
(Full List of Options)
(Full List of Options)
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
= Full List of Options =
 
= Full List of Options =
  
The following table gives a brief description of all the parameters of '''Minimac3'''. A more detailed description would be available soon.
+
The following table gives a brief description of all the parameters of '''Minimac3'''. A more detailed description would be available soon. Users should see the wiki-page on [[Minimac3 Usage | Minimac3 Usage and Documentation]] and [[Minimac3 Imputation Cookbook]] for further help on how to use these options.
  
 
{| border="1" cellpadding="2"  
 
{| border="1" cellpadding="2"  
Line 16: Line 16:
 
| <font face=Courier>--refHaps filename </font>  
 
| <font face=Courier>--refHaps filename </font>  
 
|  VCF file or <font face=Courier>M3VCF</font> file containing haplotype data for reference panel.
 
|  VCF file or <font face=Courier>M3VCF</font> file containing haplotype data for reference panel.
 +
|-
 +
| <font face=Courier>--rsid</font>
 +
| This option only imports RS ID of variants from ID column of reference file (if available).
 
|-  
 
|-  
 
| <font face=Courier>--passOnly</font>  
 
| <font face=Courier>--passOnly</font>  
Line 34: Line 37:
 
| <font face=Courier>--nobgzip</font>
 
| <font face=Courier>--nobgzip</font>
 
| If ON, output files will be NOT bgzipped.  
 
| If ON, output files will be NOT bgzipped.  
 +
|-
 +
| <font face=Courier>--vcfOutput</font>
 +
| If ON, imputed data will NOT be output as VCF output file [Default: ON].
 
|-
 
|-
 
| <font face=Courier>--doseOutput</font>
 
| <font face=Courier>--doseOutput</font>
Line 42: Line 48:
 
|-
 
|-
 
| <font face=Courier>--format</font>
 
| <font face=Courier>--format</font>
| Specifies which fields to output for the FORMAT field in output VCF file. Available handles: <font face=Courier>GT,DS,GP </font>[Default: <font face=Courier>GT,DS</font>].  
+
| Specifies which fields to output for the FORMAT field in output VCF file. Available handles: <font face=Courier>GT,DS,GP </font>[Default: <font face=Courier>GT,DS</font>]
 +
|-
 +
| <font face=Courier>--allTypedSites</font>
 +
| Also Includes variants that were genotyped but NOT in the reference panel in the output files (and imputes any missing data in such variants to the major allele frequency).
 
|-
 
|-
 
| <font face=Courier>--chr 22</font>
 
| <font face=Courier>--chr 22</font>
Line 54: Line 63:
 
|-
 
|-
 
  | <font face=Courier>--window 5000</font>
 
  | <font face=Courier>--window 5000</font>
| Length of buffer region on either side of <font face=Courier>--start</font> and <font face=Courier>--end</font>. By default = 0.
+
| Length of buffer region (in bp units) on either side of <font face=Courier>--start</font> and <font face=Courier>--end</font>. By default = 500000 (if chunking is done) and = 0 (if no chunking is being done).
 
|-  
 
|-  
 
| <font face=Courier>--rec</font>
 
| <font face=Courier>--rec</font>
Line 70: Line 79:
 
| <font face=Courier>--help</font>
 
| <font face=Courier>--help</font>
 
| A short help on options.
 
| A short help on options.
 +
|-
 +
| <font face=Courier>--lowMemory</font>
 +
| If ON, a low memory version of Minimac3 will be run.
 
|-  
 
|-  
 
| <font face=Courier>--cpus 5</font>
 
| <font face=Courier>--cpus 5</font>
Line 80: Line 92:
 
| Percentage probability of sending SUCCESS/FAILURE status of the execution to home server [Default: 50%]
 
| Percentage probability of sending SUCCESS/FAILURE status of the execution to home server [Default: 50%]
 
|}
 
|}
 
  
 
= Download =
 
= Download =

Latest revision as of 18:34, 6 June 2016

Introduction

Minimac3 is a lower memory and more computationally efficient implementation of minimac2. It is an algorithm for genotypic imputation that works on phased genotypes (say from MaCH) and is designed to handle very large reference panels in a more computationally efficient way with no loss of accuracy.

This wiki page gives users a full list of all the available options on Minimac3.

Full List of Options

The following table gives a brief description of all the parameters of Minimac3. A more detailed description would be available soon. Users should see the wiki-page on Minimac3 Usage and Documentation and Minimac3 Imputation Cookbook for further help on how to use these options.

Parameter Description
--refHaps filename VCF file or M3VCF file containing haplotype data for reference panel.
--rsid This option only imports RS ID of variants from ID column of reference file (if available).
--passOnly If ON, only variants will FILTER=PASS will be recorded from reference VCF file (does NOT work on M3VCF files yet).
--haps filename File containing haplotype data for target (gwas) samples. Must be a VCF file.
--processReference This option will only convert an input VCF file to M3VCF format (maybe for a later run of imputation). If this option is ON, no imputation would be performed and thus all other parameters will be ignored (of course, except for parameters on Reference Haplotypes and Subsetting Options). This option also does parameter estimation using the reference panel and saves them in the M3VCF file (the estimation can be skipped with rounds = 0)
--prefix output Prefix for all output files generated. By default: [Minimac3.Output]
--updateModel If ON, saved parameter estimates read from a M3VCF file will be further updated using the gwas samples. Will be ignored if VCF reference file. [Default: OFF]
--nobgzip If ON, output files will be NOT bgzipped.
--vcfOutput If ON, imputed data will NOT be output as VCF output file [Default: ON].
--doseOutput If ON, imputed data will be output as dosage file as well [Default: OFF].
--hapOutput If ON, phased imputed data will be output as well [Default: OFF].
--format Specifies which fields to output for the FORMAT field in output VCF file. Available handles: GT,DS,GP [Default: GT,DS]
--allTypedSites Also Includes variants that were genotyped but NOT in the reference panel in the output files (and imputes any missing data in such variants to the major allele frequency).
--chr 22 Chromosome number for which we will carry out imputation.
--start 100000 Start position for imputation by chunking. Would not work without --chr option.
--end 200000 End position for imputation by chunking. Would not work without --chr option.
--window 5000 Length of buffer region (in bp units) on either side of --start and --end. By default = 500000 (if chunking is done) and = 0 (if no chunking is being done).
--rec Recombination File from previous run of Minimac/Minimac3. (--err parameter must also be provided, if using this handle)
--err Error File from previous run of Minimac/Minimac3. (--rec parameter must also be provided, if using this handle)
--rounds 5 Rounds of optimization for model parameters, which describe population recombination rates and per SNP error rates. By default = 5.
--states 200 Maximum number of reference (or target) haplotypes to be examined during parameter optimization. By default = 200.
--help A short help on options.
--lowMemory If ON, a low memory version of Minimac3 will be run.
--cpus 5 Number of cpus for parallel computing. Would work only with Minimac3-omp.
--noPhoneHome If ON, code will NOT send a SUCCESS/FAILURE status of the execution to home server.
--phoneHomeThinning 50 Percentage probability of sending SUCCESS/FAILURE status of the execution to home server [Default: 50%]

Download

Minimac3 is available as an undocumented release version. The source files (and binary executable) are available for download in Source Files and commonly used reference panels in VCF and M3VCF formats are available for download in Reference Panels.

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:

Contact

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