Git Product home page Git Product logo

trust4's Introduction

trust4

Tcr Receptor Utilities for Solid Tissue (TRUST) is a computational tool to analyze TCR and BCR sequences using unselected RNA sequencing data, profiled from solid tissues, including tumors. TRUST4 performs de novo assembly on V, J, C genes including the hypervariable complementarity-determining region 3 (CDR3) and reports consensus of BCR/TCR sequences. TRUST4 then realigns the contigs to IMGT reference gene sequences to report the corresponding information.

Dependencies

Usage

Cromwell

java -jar cromwell.jar run trust4.wdl --inputs inputs.json

Inputs

Required workflow parameters:

Parameter Value Description
fastqR1 File Input file with the first mate reads.
fastqR2 File Input file with the second mate reads.
reference String Reference assembly id

Optional workflow parameters:

Parameter Value Default Description
outputFileNamePrefix String "" Output prefix, customizable. Default is the first file's basename.

Optional task parameters:

Parameter Value Default Description
runTrust4.jobMemory Int 8 Memory allocated to the task.
runTrust4.timeout Int 20 Timeout in hours, needed to override imposed limits.
runTrust4.threads Int? None Optional threads, default is 1
runTrust4.modules String "mixcr/3.0.13" Names and versions of required modules.

Outputs

Output Type Description
cdrReport File report contains CDR1,2,3 and gene information for each consensus assemblies
finalContigs File contigs and corresponding nucleotide weight
finalReport File report file focusing on CDR3 and is compatible with other repertoire analysis tool such as VDJTools
consensusAssembly File fasta file for the annotation of the consensus assembly

Commands

This section lists command(s) run by trust4 workflow

  • Running trust4

TRUST4 runs a single command which produces a number of outputs which should be analyzed in a downstream process


 set -euo pipefail
 run-trust4 -f BCRTCR.fa [--ref refIMGT.fa] [-t THREADS] -1 FASTQ_R1 -2 FASTQ_R2 -o OUTPUT_PREFIX 

Support

For support, please file an issue on the Github project or send an email to [email protected] .

Generated with generate-markdown-readme (https://github.com/oicr-gsi/gsi-wdl-tools/)

trust4's People

Contributors

pruzanov avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.