readme

README.md

 
 ## App输出文件
 
-本计算会产生大量的中间结果，这里至说明最后整合好的结果文件
+本计算会产生大量的中间结果，这里说明最后整合好的结果文件，一共5个文件。
 
-1. 原始数据质量控制
-2. 比对后数据质量控制
-3. 突变检出数据质量控制
+####1. 原始数据质量控制
+
+##### 输出目录
+
+extract_multiqc
+
+##### 输出结果文件
+
+fastqc.final.result.txt
+
+fastqscreen.final.result.txt
+
+####2. 比对后数据质量控制
+
+##### 输出目录
+
+extract_multiqc
+
+##### 输出结果文件
+
+qualimap.final.result.txt
+
+####3. 突变检出数据质量控制
+
+#####3.1 与标准集进行比较
+
+######输出目录
+
+extract_multiqc
+
+######输出结果文件
+
+benchmark.final.result.txt
+
+##### 3.2 通过Quartet家系设计
+
+###### 输出目录
+
+quartet_mendelian
+
+###### 输出结果文件
+
+${project}.mendelian.txt
 
 ## 结果展示与解读
 
-#### 
+####1. 原始数据质量控制
+
+原始数据质量控制主要通过考察测序数据的基本特征判断数据质量的好坏，比如数据量是否达到要求、reads的重复率是否过多、碱基质量、ATGC四种碱基的分布、GC含量、接头序列含量以及是否有其他物种的污染等等。
+
+FastQC和FastqScreen是两个常用的原始数据质量控制软件
+
+#####1.1 fastqc.final.result.txt
+
+| 列名                                               | 说明                                                         |
+| -------------------------------------------------- | ------------------------------------------------------------ |
+| Sample                                             | 样本名，R1结尾为read1，R2结尾为read2                         |
+| FastQC_mqc-generalstats-fastqc-percent_duplicates  | % Duplicate reads                                            |
+| FastQC_mqc-generalstats-fastqc-percent_gc          | Average % GC content                                         |
+| FastQC_mqc-generalstats-fastqc-avg_sequence_length | Reads长度                                                    |
+| FastQC_mqc-generalstats-fastqc-percent_fails       | 12个Fastqc模块中失败的比例                                   |
+| FastQC_mqc-generalstats-fastqc-total_sequences     | Total sequences                                              |
+| per_base_sequence_quality                          | pass/warn/fail；Quality就是Fred值，-10*log10(p)，p为测错的概率。所以一条reads某位置出错概率为0.01时，其quality就是20。横轴代表位置，纵轴quality。红色表示中位数，黄色是25%-75%区间，触须是10%-90%区间，蓝线是平均数。若任一位置的下四分位数低于10或中位数低于25，报"WARN"；若任一位置的下四分位数低于5或中位数低于20，报"FAIL"。 |
+| per_tile_sequence_quality                          | pass/warn/fail；每个tile的测序情况，横轴是测序序列第1个碱基到第101个碱基，纵轴是tail的Index编号，这个图主要是为了防止，在测序过程中，某些tail受到不可控因素的影响而出现测序质量偏低，蓝色代表测序质量很高，暖色代表测序质量不高，如果某些tail出现暖色，可以在后续分析中把该tail测序的结果全部都去除。 |
+| per_sequence_quality_scores                        | pass/warn/fail；每条reads的quality的均值的分布，横轴为quality，纵轴是reads数目。当出现上图的情况时，我们就会知道有一部分reads具有比较差的质量。当峰值小于27（错误率0.2%）时报"WARN"，当峰值小于20（错误率1%）时报"FAIL"。 |
+| per_base_sequence_content                          | pass/warn/fail；对所有reads的每一个位置，统计ATCG四种碱基（正常情况）的分布：横轴为位置，纵轴为百分比。 正常情况下四种碱基的出现频率应该是接近的，而且没有位置差异。因此好的样本中四条线应该平行且接近。当部分位置碱基的比例出现bias时，即四条线在某些位置纷乱交织，往往提示我们有overrepresented sequence的污染。当所有位置的碱基比例一致的表现出bias时，即四条线平行但分开，往往代表文库有bias (建库过程或本身特点)，或者是测序中的系统误差。当任一位置的A/T比例与G/C比例相差超过10%，报"WARN"；当任一位置的A/T比例与G/C比例相差超过20%，报"FAIL"。 |
+| per_sequence_gc_content                            | pass/warn/fail；统计reads的平均GC含量的分布。红线是实际情况，蓝线是理论分布（正态分布，均值不一定在50%，而是由平均GC含量推断的）。 曲线形状的偏差往往是由于文库的污染或是部分reads构成的子集有偏差（overrepresented reads）。形状接近正态但偏离理论分布的情况提示我们可能有系统偏差。偏离理论分布的reads超过15%时，报"WARN"；偏离理论分布的reads超过30%时，报"FAIL"。 |
+| per_base_n_content                                 | pass/warn/fail；当测序仪器不能辨别某条reads的某个位置到底是什么碱基时，就会产生“N”。对所有reads的每个位置，统计N的比率：正常情况下N的比例是很小的，所以图上常常看到一条直线，但放大Y轴之后会发现还是有N的存在，这不算问题。当Y轴在0%-100%的范围内也能看到“鼓包”时，说明测序系统出了问题。当任意位置的N的比例超过5%，报"WARN"；当任意位置的N的比例超过20%，报"FAIL"。 |
+| sequence_length_distribution                       | pass/warn/fail；reads长度的分布。当reads长度不一致时报"WARN"；当有长度为0的read时报“FAIL”。 |
+| sequence_duplication_levels                        | pass/warn/fail；统计序列完全一样的reads的频率。测序深度越高，越容易产生一定程度的duplication，这是正常的现象，但如果duplication的程度很高，就提示我们可能有bias的存在（如建库过程中的PCR duplication）。横坐标是duplication的次数，纵坐标是duplicated reads的数目，以unique reads的总数作为100%。 如果原始数据很大（事实往往如此），做这样的统计将非常慢，所以fastqc中用fq数据的前200,000条reads统计其在全部数据中的重复情况。重复数目大于等于10的reads被合并统计，这也是为什么我们看到上图的最右侧略有上扬。大于75bp的reads只取50bp（不知道怎么选的）进行比较。但由于reads越长越不容易完全相同（由测序错误导致），所以其重复程度仍有可能被低估。当非unique的reads占总数的比例大于20%时，报"WARN"；当非unique的reads占总数的比例大于50%时，报"FAIL“。 |
+| overrepresented_sequences                          | pass/warn/fail；如果有某个序列大量出现，就叫做over-represented。fastqc的标准是占全部reads的0.1%以上。和上面的duplicate analysis一样，为了计算方便，只取了fq数据的前200,000条reads进行统计，所以有可能over-represented reads不在里面。而且大于75bp的reads也是只取50bp。如果命令行中加入了-c contaminant file，出现的over-represented sequence会从contaminant_file里面找匹配的hit（至少20bp且最多一个mismatch），可以给我们一些线索。当发现超过总reads数0.1%的reads时报”WARN“，当发现超过总reads数1%的reads时报”FAIL“。 |
+| adapter_content                                    | pass/warn/fail；序列中两端adapter的情况；如果有adapter序列没有去除干净的情况，在后续分析的时候需要先使用cutadapt软件进行去接头，也可以用 trimmomatic来去除接头。 |
+| kmer_content                                       | pass/warn/fail；如果某k个bp的短序列在reads中大量出现，其频率高于统计期望的话，fastqc将其记为over-represented k-mer。默认的k = 5，可以用-k --kmers选项来调节，范围是2-10。出现频率总体上3倍于期望或是在某位置上5倍于期望的k-mer被认为是over-represented。fastqc除了列出所有over-represented k-mers，还会把前6个的per base distribution画出来。当有出现频率总体上3倍于期望或是在某位置上5倍于期望的k-mer时，报”WARN“；当有出现频率在某位置上10倍于期望的k-mer时报"FAIL"。 |
+
+#####1.2 fastqscreen.final.result.txt
+
+| 列名               | 说明                                                         |
+| ------------------ | ------------------------------------------------------------ |
+| Sample             | 样本名，R1结尾为read1，R2结尾为read2                         |
+| Human percentage   | 比对到人类基因组的比例                                       |
+| ERCC percentage    | 比对到External RNA Controls Consortium基因组的比例           |
+| EColi percentage   | 比对到大肠杆菌基因组的比例                                   |
+| Adapter percentage | 比对到接头序列的比例                                         |
+| Vector percentage  | 比对到载体基因组的比例                                       |
+| rRNA percentage    | 比对到rRNA序列的比例                                         |
+| Virus percentage   | 比对到病毒基因组的比例                                       |
+| Yeast percentage   | 比对到酵母基因组的比例                                       |
+| Mitoch percentage  | 比对到线粒体序列的比例                                       |
+| Phix percentage    | 比对到Phix基因组的比例。PhiX对照品v3是一款可靠、连接接头的文库，适合用作Illumina测序运行的对照品。 |
+| No hits percentage | 没有比对到以上基因组的比例                                   |
+
+#### 2. 比对后数据质量控制
+
+##### qualimap.final.result.txt
+
+| 列名                                                  | 说明                                          |
+| ----------------------------------------------------- | --------------------------------------------- |
+| Sample                                                | 样本名                                        |
+| QualiMap_mqc-generalstats-qualimap-avg_gc             | Mean GC content                               |
+| QualiMap_mqc-generalstats-qualimap-median_insert_size | Median insert size（bp）                      |
+| QualiMap_mqc-generalstats-qualimap-1_x_pc             | Fraction of genome with at least 1x coverage  |
+| QualiMap_mqc-generalstats-qualimap-5_x_pc             | Fraction of genome with at least 5x coverage  |
+| QualiMap_mqc-generalstats-qualimap-10_x_pc            | Fraction of genome with at least 10x coverage |
+| QualiMap_mqc-generalstats-qualimap-30_x_pc            | Fraction of genome with at least 30x coverage |
+| QualiMap_mqc-generalstats-qualimap-50_x_pc            | Fraction of genome with at least 50x coverage |
+| QualiMap_mqc-generalstats-qualimap-median_coverage    | Median coverage                               |
+| QualiMap_mqc-generalstats-qualimap-percentage_aligned | % mapped reads                                |
+| QualiMap_mqc-generalstats-qualimap-mapped_reads       | Number of mapped reads                        |
+| QualiMap_mqc-generalstats-qualimap-total_reads        | Total reads                                   |
+| QualiMap_mqc-generalstats-qualimap-general_error_rate | Mapping error rate                            |
+
+####3. 突变检出数据质量控制
+
+##### 3.1 与标准集对比 benchmark.final.result.txt
+
+| 列名      | 说明   |
+| --------- | ------ |
+| Sample    | 样本名 |
+| Precision | 查准率 |
+| Recall    | 查全率 |
+
+#####3.2 Quartet家系关系评估 ${project}.mendelian.txt
+
+| 列名                          | 说明                                                         |
+| ----------------------------- | ------------------------------------------------------------ |
+| Family                        | 家庭名字，我们目前的设计是4个Quartet样本，每个三个技术重复，family_1是指rep1的4个样本组成的家庭单位，以此类推。 |
+| Reproducibility_D5_D6         | Quartet-D5和Quartet-D6的一致性                               |
+| Mendelian_Concordance_Quartet | 符合孟德尔遗传的比例                                         |
+