Name Mode Size
.github 040000
R 040000
inst 040000
man 040000
tests 040000
vignettes 040000
.BBSoptions 100644 0 kb
.Rbuildignore 100644 0 kb
.gitignore 100644 0 kb
DESCRIPTION 100644 2 kb
Dockerfile 100644 0 kb
NAMESPACE 100644 3 kb 100644 4 kb
TVTB.Rproj 100644 0 kb
appveyor.yml 100644 2 kb
codecov.yml 100644 0 kb
<img src="man/figures/logo.png" align="right" alt="logo.png" width="180" /> # The VCF Tool Box (TVTB) <!-- badges: start --> [![R build status](]( [![ coverage status](]( [![Docker Cloud Automated build](]( <!-- badges: end --> ## Bioconductor release status | Branch | R CMD check | Last updated | |:----------------:|:----------------:|:------------:| | [_devel_]( | [![Bioconductor-devel Build Status](]( | ![]( | | [_release_]( | [![Bioconductor-release Build Status](]( | ![]( | ## Description The package provides functions to filter, summarise and visualise genetic variation data stored in VCF files. Functionalities are also demonstrated in a Shiny web-application. ## Motivation The VCF file format encodes a plethora of useful information, including optional predictions using the [Ensembl Variant Effect Predictor (VEP)]( that can be parsed using expert packages such as [`VariantAnnotation`]( and formatted into `VCF` objects. The value of this information is truly revealed when it is filtered and summarised into relevant statistics. This package offers methods: * to subset and summarise `VCF` objects including Ensembl VEP predictions, * to explore genetic variants, * and to report various summary statistics. ## Installation Instructions to install the latest release of TVTB are available at: Using `devtools`, versions more recent than the official releases can be obtained: install.packages("devtools") The latest version pushed to Bioconductor [release]( (_may be more recent than the official release in the absence of version bump_) : devtools::install_github("Bioconductor-mirror/TVTB", ref="release-3.4") The latest version pushed to Bioconductor [devel]( (_as above_): devtools::install_github("Bioconductor-mirror/TVTB", ref="master") Original [GitHub]( development repository: devtools::install_github("kevinrue/TVTB") Specific commit: devtools::install_github("kevinrue/TVTB", ref="99966dda") ## Graphical User Interface Although nothing offers more flexibility than the command line interface, a [Shiny]( web-application, _the Shiny Variant Explorer_ (tSVE), offers a GUI to get familiar with the major functionalities of the package. ## Tests Unit tests and coverage implemented using the `testthat` package (CRAN). Coverage excludes files: * AllClasses.R (_Not executed at runtime_) * tSVE.R (_Requires interactive session_) ## License **Artistic License 2.0**