Title: | T-cell Receptor/Immunoglobulin Profiler (TRIP) |
---|---|
Description: | TRIP is a software framework that provides analytics services on antigen receptor (B cell receptor immunoglobulin, BcR IG | T cell receptor, TR) gene sequence data. It is a web application written in R Shiny. It takes as input the output files of the IMGT/HighV-Quest tool. 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. |
Authors: | Maria Th. Kotouza [aut], Katerina Gemenetzi [aut], Chrysi Galigalidou [aut], Elisavet Vlachonikola [aut], Nikolaos Pechlivanis [cre], Andreas Agathangelidis [aut], Raphael Sandaltzopoulos [aut], Pericles A. Mitkas [aut], Kostas Stamatopoulos [aut], Anastasia Chatzidimitriou [aut], Fotis E. Psomopoulos [aut], Iason Ofeidis [aut], Aspasia Orfanou [aut] |
Maintainer: | Nikolaos Pechlivanis <[email protected]> |
License: | MIT + file LICENSE |
Version: | 1.13.0 |
Built: | 2024-10-31 06:29:17 UTC |
Source: | https://github.com/bioc/tripr |
Run the Shiny Application
run_app( onStart = NULL, options = list(launch.browser = TRUE), enableBookmarking = NULL, uiPattern = "/", ... )
run_app( onStart = NULL, options = list(launch.browser = TRUE), enableBookmarking = NULL, uiPattern = "/", ... )
onStart |
A function that will be called before the app is actually run.
This is only needed for |
options |
Named options that should be passed to the |
enableBookmarking |
Can be one of |
uiPattern |
A regular expression that will be applied to each |
... |
arguments to pass to golem_opts. See '?golem::get_golem_options' for more details. |
None
if (interactive()) { run_app(options = list(launch.browser = FALSE)) }
if (interactive()) { run_app(options = list(launch.browser = FALSE)) }
run_TRIP()
is a wrapper of {tripr} shiny analysis tool for use via R
command line.
Output of analysis is saved in tripr/extdata/output folder, where R
libraries are saved (typically R/library).
run_TRIP( datapath = fs::path_package("extdata", "dataset", package = "tripr"), output_path = fs::path_home("Documents/tripr_output"), filelist = c("1_Summary.txt", "2_IMGT-gapped-nt-sequences.txt", "4_IMGT-gapped-AA-sequences.txt", "6_Junction.txt"), cell = "Bcell", throughput = "High Throughput", preselection = "1,4C:W", selection = "5", identity_range = "85:100", vgenes = "", dgenes = "", jgenes = "", cdr3_length_range = "", aminoacid = "", pipeline = "1", select_clonotype = "V Gene + CDR3 Amino Acids", highly_sim_params = paste0("1-1 2-1 3-1 4-1 5-1 6-1 7-1 8-1 9-1 10-1 11-1 ", "12-1 13-1 14-1 15-2 16-2 17-2 18-2 19-2 20-2 21-2 23-2 24-2 25-2 ", "26-2 27-2 28-2 29-3 30-3 31-3 32-3 33-3 34-3 35-3 36-3 37-3 38-3 ", "39-3 40-3 41-3 42-3 43-3 44-3 45-3 46-3 47-3 48-3 49-3 50-3,1,Yes"), shared_clonotypes_params = "reads,1,Yes", highly_shared_clonotypes_params = "reads,1,Yes", repertoires_params = "1,4,6", identity_groups = "85:97,97:99,99:100,100:100", multiple_values_params = "2:7,2:3,2:5,2:11", alignment_params = "1,both,1,2:20", mutations_params = "both,0.5,0.5,2:20" )
run_TRIP( datapath = fs::path_package("extdata", "dataset", package = "tripr"), output_path = fs::path_home("Documents/tripr_output"), filelist = c("1_Summary.txt", "2_IMGT-gapped-nt-sequences.txt", "4_IMGT-gapped-AA-sequences.txt", "6_Junction.txt"), cell = "Bcell", throughput = "High Throughput", preselection = "1,4C:W", selection = "5", identity_range = "85:100", vgenes = "", dgenes = "", jgenes = "", cdr3_length_range = "", aminoacid = "", pipeline = "1", select_clonotype = "V Gene + CDR3 Amino Acids", highly_sim_params = paste0("1-1 2-1 3-1 4-1 5-1 6-1 7-1 8-1 9-1 10-1 11-1 ", "12-1 13-1 14-1 15-2 16-2 17-2 18-2 19-2 20-2 21-2 23-2 24-2 25-2 ", "26-2 27-2 28-2 29-3 30-3 31-3 32-3 33-3 34-3 35-3 36-3 37-3 38-3 ", "39-3 40-3 41-3 42-3 43-3 44-3 45-3 46-3 47-3 48-3 49-3 50-3,1,Yes"), shared_clonotypes_params = "reads,1,Yes", highly_shared_clonotypes_params = "reads,1,Yes", repertoires_params = "1,4,6", identity_groups = "85:97,97:99,99:100,100:100", multiple_values_params = "2:7,2:3,2:5,2:11", alignment_params = "1,both,1,2:20", mutations_params = "both,0.5,0.5,2:20" )
datapath |
(character) The directory where the folders of the data
is located. Note that every sample of the dataset must have its
own individual folder and every sample folder must
be in one root folder. Note that every file in the root
folder will be used in the analysis. |
output_path |
(character) The directory where the output data will
be stored. Please provide a valid path, ideally the same way as datapath
by using the path_home function. |
filelist |
(character vector) The character vector of files of the IMGT output that will be used through the analysis from each sample. |
cell |
(character) 'Bcell' (default) or 'Tcell'. |
throughput |
(character) 'High Throughput' (default) or 'Low Throughput'. |
preselection |
(character) Preselection options: |
selection |
(character) Selection options: |
identity_range |
(character) V-REGION identity Use colon ':' to seperate identity low and high |
vgenes |
(character) Filter in specific V Genes, |
dgenes |
(character) Filter in specific D Genes, |
jgenes |
(character) Filter in specific J Genes, |
cdr3_length_range |
(character) Filter in rows with CDR3 lengths
within a range, |
aminoacid |
(character) Filter in rows with CDR3 containing specific amino-acid sequence |
pipeline |
(character) Pipeline options: |
select_clonotype |
(character) Compute clonotypes. |
highly_sim_params |
(character) Select number of missmatches, the threshold of the clonotype frequency and whether you want to take gene into account. Use dashes '-' to show the length of the CDR3 sequences and the number of allowed missmatches and spaces ' ' to separate. For the CDR3 lengths with not specified number of missmatches the default value is 1. Use comma ',' to separate the three options. |
shared_clonotypes_params |
(character) Shared clonotypes computation. |
highly_shared_clonotypes_params |
(character) Highly Similar Shared
Clonotypes Computation |
repertoires_params |
(character) Repertoires Extraction |
identity_groups |
(character) Insert identity groups |
multiple_values_params |
(character) Multiple value comparison |
alignment_params |
(character) Alignment parameters: |
mutations_params |
(character) Somatic hypermutations parameters: |
None
## Do not run run_TRIP( output_path=tools::R_user_dir("tripr", which="cache"), filelist=c("1_Summary.txt", "2_IMGT-gapped-nt-sequences.txt", "4_IMGT-gapped-AA-sequences.txt", "6_Junction.txt"), cell="Bcell", throughput="High Throughput", preselection="1,2,3,4C:W", selection="5", identity_range="88:100", cdr3_length_range="", pipeline="1", select_clonotype="V Gene + CDR3 Amino Acids")
## Do not run run_TRIP( output_path=tools::R_user_dir("tripr", which="cache"), filelist=c("1_Summary.txt", "2_IMGT-gapped-nt-sequences.txt", "4_IMGT-gapped-AA-sequences.txt", "6_Junction.txt"), cell="Bcell", throughput="High Throughput", preselection="1,2,3,4C:W", selection="5", identity_range="88:100", cdr3_length_range="", pipeline="1", select_clonotype="V Gene + CDR3 Amino Acids")
T-cell Receptor/Immunoglobulin Profiler (TRIP)
The only function you're likely to need from tripr is [run_app()]. Otherwise refer to the vignettes for using tripr.
Maintainer: Nikolaos Pechlivanis [email protected]
Authors:
Maria Th. Kotouza
Katerina Gemenetzi
Chrysi Galigalidou
Elisavet Vlachonikola
Andreas Agathangelidis
Raphael Sandaltzopoulos
Pericles A. Mitkas
Kostas Stamatopoulos
Anastasia Chatzidimitriou
Fotis E. Psomopoulos
Iason Ofeidis
Aspasia Orfanou
Useful links:
Report bugs at https://github.com/BiodataAnalysisGroup/tripr/issues