MIPprotect T1 extunderscore api Documentation - Read the Docs

73 Pages·2016·0.57 MB·English

MIP_api Documentation
Release 4.0.0
Måns Magnusson, Robin Andeer
December19,2016

Contents
1 Overview 3
2 Features 5
3 ExampleUsage 7
4 GettingStarted 9
4.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.3 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5 ChangeLog 13
6 Installation 27
6.1 AutomatedInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.2 ManualInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7 Setup 29
7.1 Filenameconvention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.2 Dependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
8 MIPAnalysis 33
8.1 Startstandardanalysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
8.2 Excludingaprogramfromtheanalysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8.3 Skippingaalreadyprocessedmodulei.eexpectthattheouputhasalreadybeengenerated . . . . . . 34
8.4 Simulatestandardanalysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8.5 Rerunanalysisusingexactlythesameparametersaslastanalysisrun . . . . . . . . . . . . . . . . . 34
8.6 Rerunanalysisusingexactlythesameparametersaslastanalysisrun,butinsimulationmode . . . . 34
8.7 Generateallsupportedstandardprograms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8.8 Youcanalsomodulatethemodeof‘-pp’using-ppm: . . . . . . . . . . . . . . . . . . . . . . . . . 35
9 Addinganewprogram 37
9.1 CallDefineParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
9.2 CommandlineargumentsinGetOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
9.3 if-blockruncheckerinMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
9.4 Customsubroutine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.5 Furtherinformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
10 Structure 43
i
10.1 mip.pl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.2 SequenceQC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.3 Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.4 BAMfilemanipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.5 CoverageQC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.6 Variantcalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.7 VariantQC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.8 VariantSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.9 Variantannotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.10 Variantevaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.11 qcCollect.pl. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.12 covplots_exome.R/covplots_genome.R . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
11 vcfParser 45
11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
11.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
12 QCCollect 47
12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
12.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
12.3 SetUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
13 rank_modelv1.18 49
13.1 Consequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
13.2 Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
13.3 InheritanceModel(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
13.4 ProteinFunctionalPrediction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
13.5 GeneIntoleranceScore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
13.6 VariantQualityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.7 Conservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.8 CombinedAnnotationDependentDepletion(CADD) . . . . . . . . . . . . . . . . . . . . . . . . . 54
13.9 ClinVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
13.10 Spidex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
14 rank_modelv1.11 57
14.1 Consequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
14.2 Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
14.3 InheritanceModel(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
14.4 ProteinFunctionalPrediction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
14.5 VariantQualityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
14.6 Conservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
14.7 CombinedAnnotationDependentDepletion(CADD) . . . . . . . . . . . . . . . . . . . . . . . . . 60
14.8 ClinVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
15 rank_modelv1.5 63
15.1 Consequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
15.2 Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
15.3 InheritanceModel(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
15.4 ProteinFunctionalPrediction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
15.5 VariantQualityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
15.6 Conservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
15.7 CombinedAnnotationDependentDepletion(CADD) . . . . . . . . . . . . . . . . . . . . . . . . . 66
15.8 ClinVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
16 svrank_modelv1.0 69
ii
16.1 Consequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
16.2 Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
16.3 SVType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
16.4 SVLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
16.5 GeneIntoleranceScore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
16.6 InheritanceModel(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
16.7 VariantQualityFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
17 DynamicConfigurationFile 75
18 PedigreeFile 77
18.1 Pedigreecapturekitsaliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
19 IndividualIdentificationNumber(IDN) 81
19.1 IDNDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
20 TheCode 83
20.1 Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
21 Indicesandtables 85
iii
iv
MIP_apiDocumentation,Release4.0.0
Release4.0.
MIPisapipelineforclinicalanalysisofwholeexomeandwholegenomesequencedata.
Contents:
MIPenablesidentificationofpotentialdiseasecausingvariantsfromsequencedata.
Contents 1
MIP_apiDocumentation,Release4.0.0
2 Contents
1
CHAPTER
Overview
MIP performs whole genome or target region analysis of sequenced single-end and/or paired-end reads from the
Illuminaplatforminfastq(.gz)formattogenerateannotatedrankedpotentialdiseasecausingvariants. MIPperforms
QC, alignment, coverage analysis, variant discovery and annotation, sample checks as well as ranking the found
variants according to disease potential with a minimum of manual intervention. MIP is compatible with Scout and
Puzzleforvisualizationofidentifiedvariants. MIPhasbeeninuseintheclinicalproductionattheClinicalGenomics
facilityatScienceforLifeLaboratorysince2014.
3
MIP_apiDocumentation,Release4.0.0
4 Chapter1. Overview