appreci8Rshiny: A user interface to perform the whole appreci8-analysis
In sandmanns/appreci8R: appreci8R: an R/Bioconductor package for filtering SNVs and short indels with high sensitivity and high PPV
View source: R/appreci8R_GUI.R
appreci8Rshiny R Documentation
A user interface to perform the whole appreci8-analysis
Description
appreci8R combines and filters the output of different variant calling tools according to the 'appreci8'-algorithm. The whole analysis-pipeline consists of seven steps. Individual functions for executing these steps are available. However, an additional user-interface is available that enables easy execution of the analysis-pipeline, restarting parts of the pipeline from checkpoints, changing parameters, exporting and importing the configuration and evaluation of the results. The user-interface is opend by executing the function appreci8Rshiny.
Usage
appreci8Rshiny()
Arguments
No arguments have to be provided.
Details
The user-interface is structured by tabs: Analysis, Overview results and Detailed results.
Analysis: The tab is essential for performing the whole analysis. It is further separated into 10 additional tabs:
* Important notes: General information on prerequisites for performing the analysis and current limitations (only hg19).
* 0. Preparations: Defining the general output folder and the varaint caller input. GATK, Platypus, VarScan, FreeBayes, LoFreq, SNVer, SamTools and VarDict are available as these make up the classical appreci8-pipeline. The tools can be added or removed. For every tool the following parameters have to be defined: the folder containing the variant calling results, the output file type (vcf or txt; as vcf is a standardized format, the columns containing chr, pos, ref and alt are assumed to be fixed; when selecting txt, the columns containing chr, pos, ref and alt have to be defined), a possible suffix for naming the output, if MNVs are reported (AG>CT instead of A>C and G>T), if SNVs and indels are reported in one file (if not, what is the suffix for the SNV files and what is the suffix for the indel files?), and how are indels reported. In addition to the eight tools, up to 5 additional tools can be added (select the number and click Go). In addition to the previous parameters, a name can be defined for each additionally added tool.
* 1. Target filtration: Upload your target region (bed file; chromosome definition without 'chr').
* 2. Normalization
* 3. Annotation: Annotates the variants and filters them according to the selected locations (coding, intron, threeUTR, fiveUTR, intergenic, spliceSite, promoter) and consequences (synonymous, nonsynonymous, frameshift, nonsense, not translated) of interest.
* 4. Combine output
* 5. Evaluate Coverage and BQ: Evaluate coverage and base quality by analyzing the bam files. Calls with insufficient coverage and or base quality are filtered. The following parameters have to be defined: the folder containing the bam- and bai files, minimum coverage, minimum number of reads carrying the alternate allele, minimum VAF, minimum base quality and the maximum difference in base quality between reference and alternative.
* 6. Extended Set of Characteristics: Select the databases you would like to query (dbSNP, 1000Genomes, ExAC, Genome Aggregation Database, COSMIC, ClinVar) and the source you would like to use for impact prediction (SIFT, Provean, PolyPhen2).
* 7. Final Filtration: Adjust parameters and define input for the final filtration. A bed file containing the primer positions can be uploaded (optional). A txt file containing expected/hotspot mutations (defined via gene, mutation on AA level, and an optional minimum VAF) can be uploaded (optional). Stricter thresholds for coverage and base quality can be defined (see parameters for 5. Evaluate Coverage and BQ). The number of samples making a call striking can be defined. Dependent on the previously selected source for impact prediction (SIFT, Provean, PolyPhen2), a threshold can be defined to identify reliable damaging predictions and reliable tolerated prediction. Furthermore, the default scoring for the artifact- and the polymorphism score can be changed (just recommended for experts).
* Action: The complete analysis can be executed (Start complete analysis). The availability of checkpoints can be checked (Check for possible checkpoints). If checkpoints are available, one can be selected and the analysis can be started from the selected checkpoint. The defined configuration can be exported (Export current configuration) as well as imported (Import configuration). Press Done if you are done with your analysis.
Overview results: The tab provides an overview of the results. It is further separated into 5 additional tabs:
* Log: The log of the analysis is displayed here. In case of errors, e.g. input not being available, these messages are also reported in the log.
* Raw Calls: The raw number of calls per sample and per caller are reported.
* Calls On Target: The number of calls on target per sample and per caller are reported.
* Annotaed Calls: The number of annotated (and filtered according to annotation) calls per sample and per caller are reported.
* Filtered Calls: The number of coverage and base quality filtered calls per sample is reported.
Detailed results: The tab provides detailed information on the results. It is further separated into 3 additional tabs:
* Mutations: Variant calls classified as likely true mutations.
* Polymorphisms: Variant calls classified as likely polymorphisms.
* Artifacts: Variant calls classified as likely artifacts.
Value
No value is returned.
Author(s)
Sarah Sandmann <sarah.sandmann@uni-muenster.de>
See Also
appreci8R, filterTarget, normalize, annotate, combineOutput, evaluateCovAndBQ, determineCharacteristics, finalFiltration
Examples
appreci8Rshiny()
sandmanns/appreci8R documentation built on Dec. 18, 2024, 3:23 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/appreci8R_GUI.R
| appreci8Rshiny | R Documentation |
A user interface to perform the whole appreci8-analysis
Description
appreci8R combines and filters the output of different variant calling tools according to the 'appreci8'-algorithm. The whole analysis-pipeline consists of seven steps. Individual functions for executing these steps are available. However, an additional user-interface is available that enables easy execution of the analysis-pipeline, restarting parts of the pipeline from checkpoints, changing parameters, exporting and importing the configuration and evaluation of the results. The user-interface is opend by executing the function appreci8Rshiny.
Usage
appreci8Rshiny()
Arguments
No arguments have to be provided.
Details
The user-interface is structured by tabs: Analysis, Overview results and Detailed results.
Analysis: The tab is essential for performing the whole analysis. It is further separated into 10 additional tabs:
* Important notes: General information on prerequisites for performing the analysis and current limitations (only hg19).
* 0. Preparations: Defining the general output folder and the varaint caller input. GATK, Platypus, VarScan, FreeBayes, LoFreq, SNVer, SamTools and VarDict are available as these make up the classical appreci8-pipeline. The tools can be added or removed. For every tool the following parameters have to be defined: the folder containing the variant calling results, the output file type (vcf or txt; as vcf is a standardized format, the columns containing chr, pos, ref and alt are assumed to be fixed; when selecting txt, the columns containing chr, pos, ref and alt have to be defined), a possible suffix for naming the output, if MNVs are reported (AG>CT instead of A>C and G>T), if SNVs and indels are reported in one file (if not, what is the suffix for the SNV files and what is the suffix for the indel files?), and how are indels reported. In addition to the eight tools, up to 5 additional tools can be added (select the number and click Go). In addition to the previous parameters, a name can be defined for each additionally added tool.
* 1. Target filtration: Upload your target region (bed file; chromosome definition without 'chr').
* 2. Normalization
* 3. Annotation: Annotates the variants and filters them according to the selected locations (coding, intron, threeUTR, fiveUTR, intergenic, spliceSite, promoter) and consequences (synonymous, nonsynonymous, frameshift, nonsense, not translated) of interest.
* 4. Combine output
* 5. Evaluate Coverage and BQ: Evaluate coverage and base quality by analyzing the bam files. Calls with insufficient coverage and or base quality are filtered. The following parameters have to be defined: the folder containing the bam- and bai files, minimum coverage, minimum number of reads carrying the alternate allele, minimum VAF, minimum base quality and the maximum difference in base quality between reference and alternative.
* 6. Extended Set of Characteristics: Select the databases you would like to query (dbSNP, 1000Genomes, ExAC, Genome Aggregation Database, COSMIC, ClinVar) and the source you would like to use for impact prediction (SIFT, Provean, PolyPhen2).
* 7. Final Filtration: Adjust parameters and define input for the final filtration. A bed file containing the primer positions can be uploaded (optional). A txt file containing expected/hotspot mutations (defined via gene, mutation on AA level, and an optional minimum VAF) can be uploaded (optional). Stricter thresholds for coverage and base quality can be defined (see parameters for 5. Evaluate Coverage and BQ). The number of samples making a call striking can be defined. Dependent on the previously selected source for impact prediction (SIFT, Provean, PolyPhen2), a threshold can be defined to identify reliable damaging predictions and reliable tolerated prediction. Furthermore, the default scoring for the artifact- and the polymorphism score can be changed (just recommended for experts).
* Action: The complete analysis can be executed (Start complete analysis). The availability of checkpoints can be checked (Check for possible checkpoints). If checkpoints are available, one can be selected and the analysis can be started from the selected checkpoint. The defined configuration can be exported (Export current configuration) as well as imported (Import configuration). Press Done if you are done with your analysis.
Overview results: The tab provides an overview of the results. It is further separated into 5 additional tabs:
* Log: The log of the analysis is displayed here. In case of errors, e.g. input not being available, these messages are also reported in the log.
* Raw Calls: The raw number of calls per sample and per caller are reported.
* Calls On Target: The number of calls on target per sample and per caller are reported.
* Annotaed Calls: The number of annotated (and filtered according to annotation) calls per sample and per caller are reported.
* Filtered Calls: The number of coverage and base quality filtered calls per sample is reported.
Detailed results: The tab provides detailed information on the results. It is further separated into 3 additional tabs:
* Mutations: Variant calls classified as likely true mutations.
* Polymorphisms: Variant calls classified as likely polymorphisms.
* Artifacts: Variant calls classified as likely artifacts.
Value
No value is returned.
Author(s)
Sarah Sandmann <sarah.sandmann@uni-muenster.de>
See Also
appreci8R, filterTarget, normalize, annotate, combineOutput, evaluateCovAndBQ, determineCharacteristics, finalFiltration
Examples
appreci8Rshiny()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.