<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- TODO: badges -->
<!-- badges: start -->
<!-- [](https://www.tidyverse.org/lifecycle/#stable) -->
<!-- [](http://bioconductor.org/checkResults/release/data-experiment-LATEST/spatialLIBD/) -->
<!-- [](http://bioconductor.org/checkResults/devel/data-experiment-LATEST/spatialLIBD/) -->
<!-- [](https://codecov.io/gh/BiodataAnalysisGroup/tripr?branch=master) -->
<!-- [](https://support.bioconductor.org/t/spatialLIBD/) -->
<!-- [](https://github.com/BiodataAnalysisGroup/tripr/issues) -->
<!-- [](https://zenodo.org/badge/latestdoi/225913568) -->
<!-- badges: end -->
# tripr <img src="inst/app/www/tripr.png" align="right" width="200" />
T-cell Receptor/Immunoglobulin Profiler (TRIP)
[](https://github.com/BiodataAnalysisGroup/tripr/actions/workflows/check-bioc.yml)
## Description
`tripr` is a [Bioconductor](http://bioconductor.org) package, written in
[shiny](https://shiny.rstudio.com/) that provides analytics services on
antigen receptor (B cell receptor immunoglobulin, BcR IG | T cell
receptor, TR) gene sequence data. Every step of the analysis can be
performed interactively, thus not requiring any programming skills. It
takes as input the output files of the [IMGT/HighV-Quest
tool](http://www.imgt.org/HighV-QUEST/home.action). Users can select to
analyze the data from each of the input samples separately, or the
combined data files from all samples and visualize the results
accordingly.
Functions for an `R` command-line use are also available.
## Installation
<!-- When accepted in Bioconductor -->
`tripr` is distributed as a [Bioconductor](https://www.bioconductor.org/)
package and requires `R` (version "4.2"), which can be installed on any
operating system from [CRAN](https://cran.r-project.org/), and
Bioconductor (version "3.15").
To install `tripr` package enter the following commands in your `R` session:
```r
if (!requireNamespace("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("tripr")
## Check that you have a valid Bioconductor installation
BiocManager::valid()
```
## Launching the app
Once `tripr` is successfully installed, it can be loaded as follow:
``` r
library(tripr)
```
## User Guide
To view documentation for the version of this package installed in your system,
start R and enter:
``` r
browseVignettes("tripr")
```
