SHAPEIT v2.727 (25 September 2013)

The main improvement in SHAPEIT version 2 resides in the new model used for the conditioning haplotypes. It is a generalisation of the "surrogate family" phasing idea that can now be applied at the whole chromosome scale. It results in improved accuracy and speed compared to version 1. This new model is used by default and can be controlled via two parameters, the average window size (W) and the number of haplotypes to be considered per window (K). Default values for these parameters can be changed using the options --window and --states respectively. The graph representation of the conditioning haplotypes (the underlying model of version 1) can still be used if you add --version1 flag to the SHAPEIT command line.

Major changes made

What version of SHAPEIT do I have?

To know the SHAPEIT version you have, use this command:

shapeit --version

How to ask a question, report a problem and know about new versions?

Subscribe on the OXSTATGEN mailing list.

If you experience any problems with SHAPEIT, hereafter some advice before mailing:

  1. Make sure you are using the latest version since your problem may have already been fixed
  2. Check carefully the screen output and the log file. The problem may be reported here since they both contain many details about what is going on.

If the problem persists, ask your question on the OXSTATGEN mailing list and we will be happy to answer!

SHAPEIT v1.X (old versions)

It is strongly advised to download and use the latest version (that you can find below) instead of this versions since some minor bugs were corrected.

v1.ESHG (23 June 2012)

  1. Major: New option --chrX to phase X chromosomes.
  2. Major: New option --input-ref to phase using a reference panel of haplotypes (1KGP).
  3. Major: More complete log files with many useful statistics that can be direclty input in R about missingness per snp/individual, allele frequencies, mendel errors, heterozygous haploids, etc ...
  4. Minor: All input files can be given as Gzipped or Bzipped as soon as the correct file extension is given (.gz and .bz2). They will be internally decompressed.
  5. Minor: All output files can be internally compressed using Gzip or Bzip2 as soon as the correct file extension is given (.gz and .bz2).
  6. Minor: Any information in the input sample file are propagated into the output sample file as the phenotypes for example. Idem for PED and FAM files.
  7. Minor: Verbose on the screen was reduced.
  8. Minor: Unphased genotype files can be given in a more parsimonious way. For example --input-bed file.bed file.bim file.fam can be now written as --input-bed file.

v1.r532:

  1. Minor: bugfix in trio/duo phasing.

v1.r416:

  1. Minor: When running on ped/map files at monomorphic SNPs the output files listed the two alleles as the observed allele and 0. This has now been changed so that the observed allele is listed twice. This provides better compatibility with IMPUTE2.

v1.r415:

  1. Major: Unrelateds are ordered in the same way in input and output files.
  2. Minor: Covariates and phenotypes in input sample file are given in output sample file (still don't work when the option --output-graph is used).
  3. Minor: When output window coordinates are not consistent with input window coordinates, they are automatically fixed

v1.r378:

  1. Major: SNPs are not uniquely identified by their ID anymore, but rather by their physical position.
  2. Minor: Compiled on older Linux version for better compatibility.
  3. Minor: Improved initial data checking (calling rate / Mendel error rate).
  4. Minor: New data sub-setting options ( --include-ind --exclude-ind --include-snp --exclude-snp --output-from --output-to )
  5. Minor: New testing option to check that data reading is OK ( --test-reading )

v1.r331:

Licence

Academic License Agreement

The bioinformatics department of Conservatoire National des Arts et Metiers (CNAM) has developed a new algorithm for a faster computation of hidden Markov models, based on graph representations. This algorithm has been notably applied for the reconstruction of haplotypes from population genotypic data leading to the SHAPEIT software. This algorithm and its applications, including SHAPEIT, are patent pending. The Conservatoire National des Arts et M?tiers (CNAM), Prof. Jean-Fran?ois ZAGURY and his group of the bioinformatics department (the developers), give permission for you and your laboratory (Institution) to use SHAPEIT. CNAM and the developers allow researchers at your Institution to copy and modify SHAPEIT for internal, non-profit research purposes, on the following conditions:

  1. The SHAPEIT software remains at your Institution and is not published, distributed, or otherwise transferred or made available to other than Institution employees and students involved in research under your supervision. If you wish to obtain SHAPEIT for any commercial purposes or for diffusion through the internet, you will need to execute a separate licensing agreement with CNAM and pay a fee. This includes, but is not limited to, using SHAPEIT to provide services to outside parties for a fee. In that case please contact :
    Pr. Zagury, CNAM.
    Tel : 33 1 58 80 88 20
    Mail : zagury at cnam.fr
  2. You retain in SHAPEIT and any modifications to SHAPEIT, the copyright, trademark, or other notices pertaining to SHAPEIT as provided by CNAM.
  3. You provide the developers with feedback on the use of SHAPEIT in your research, and that the Developers and CNAM are permitted to use any information you provide in making changes to the SHAPEIT software. All bug reports and technical questions shall be sent to:
    Dr. Delaneau, CNAM.
    Mail: olivier.delaneau at gmail.com
  4. You acknowledge that the developers, CNAM and its licensees may develop modifications to SHAPEIT that may be substantially similar to your modifications of SHAPEIT, and that the developers, CNAM and its licensees shall not be constrained in any way by you in CNAM's or its licensees' use or management of such modifications. You acknowledge the right of the developers and CNAM to prepare and publish modifications to SHAPEIT that may be substantially similar or functionally equivalent to your modifications and improvements, and if you obtain patent protection for any modification or improvement to SHAPEIT you agree not to allege or enjoin infringement of your patent by the Developers, CNAM or by any of CNAM's licensees obtaining modifications or improvements to SHAPEIT from the CNAM or the Developers.
  5. If utilisation of the SHAPEIT software results in outcomes which will be published, please specify the version of SHAPEIT you used and cite the source below :
    O. Delaneau, J. Marchini, JF. Zagury. A linear complexity phasing method for thousands of genomes. Nature Methods . Published online Nat Methods. 2011 Dec 4;9(2):179-81. doi: 10.1038/nmeth.1785.
  6. Any risk associated with using the SHAPEIT software at your institution is with you and your Institution. SHAPEIT is experimental in nature and is made available as a research courtesy "AS IS," without obligation by CNAM to provide accompanying services or support.
  7. CNAM AND THE AUTHORS EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES REGARDING THE SOFTWARE, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES PERTAINING TO MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Commercial License Agreement

A specific license must be obtained for any commercial or for-profit organization or for any web-diffusion purpose. For more information one needs to contact Prof. Zagury at:

Chaire de Bioinformatique
CNAM
292 rue Saint-Martin
75003 - PARIS
Tel : 33 1 58 80 88 20
Mail : zagury@cnam.fr