Learn R Programming

TrustVDJ

The goal of TrustVDJ is to read immune repertoire data, especially from TRUST4, 10x Genomics cellranger or AIRR format results.

Installation

TrustVDJ is available on CRAN

install.packages('TrustVDJ')

Example

There are some basic examples showing how to read 10x/TRUST4 data commonly:

library(TrustVDJ)
## basic example code
# 10x cellranger:
airr10x   = system.file('extdata', '10x_airr_rearrangement.tsv.gz', package = 'TrustVDJ')
contig10x = system.file('extdata', '10x_filtered_contig_annotations.csv.gz', package = 'TrustVDJ')
vdj10x    = Read10x(airr_file = airr10x, contig_file = contig10x, verbose = FALSE)
summary(vdj10x[,1:3])
#>    cell_id            clone_id         sequence_id       
#>  Length:40          Length:40          Length:40         
#>  Class :character   Class :character   Class :character  
#>  Mode  :character   Mode  :character   Mode  :character
# TRUST4:
airrTrust = system.file('extdata', 'TRUST4_airr.tsv.gz', package = 'TrustVDJ')
bcTrust   = system.file('extdata', 'TRUST4_barcode_report.tsv.gz', package = 'TrustVDJ')
vdjTrust  = ReadTrust(airr_file = airrTrust, barcode_report_file = bcTrust, verbose = FALSE)
summary(vdjTrust[,1:3])
#>  sequence_id          sequence           rev_comp        
#>  Length:3245        Length:3245        Length:3245       
#>  Class :character   Class :character   Class :character  
#>  Mode  :character   Mode  :character   Mode  :character

Copy Link

Version

Install

install.packages('TrustVDJ')

Monthly Downloads

68

Version

0.1.0

License

GPL (>= 3)

Maintainer

Lianhao Song

Last Published

March 16th, 2022

Functions in TrustVDJ (0.1.0)

.Read10x_consensus

Read 10x consensus file
cbinds

Combine Two Data-frame by Columns
.ReadTrust_Report

Read TRUST4 report file.
show,Trust-method

Overview of the Trust class
.Read10x_clonotype

Read 10x clonotype file
timer

Time record
show,consensus-method

Overview of the consensus class
df_chain

data.frame a single chain information
.Read10x_contig

Read 10x contig file
.ReadAIRR

Read AIRR file.
.ReadTrust_BarcodeReport

Read TRUST4 barcode_report file.
build_IMGT_reference

Build IMGT database reference
consensus-class

The consensus class
Download

Download files retryable
ReadTrust

Read AIRR/TRUST4 report files
Read10x

Read AIRR/10x report files
Ifnull

Default for NULL value
Ifnone

Default for NULL and NA value
corTest

Test for Correlation
Trust-class

The Trust class