efischer/BiGpairSEQ
1
0
Fork 0
Code Issues Pull Requests Projects Releases 13 Wiki Activity

move readme

Browse Source
This commit is contained in:
efischer
2022-02-20 12:02:27 -06:00
parent f2b5d9e1b7
commit 2c01a0211c
1 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
out/artifacts/BiGpairSEQ_Sim_jar/readme.md
View File

@@ -1,32 +0,0 @@
BiGpairSEQ SIMULATOR
ABOUT:
This program simulates BiGpairSEQ, a graph theory based adaptation
of the pairSEQ algorithm for pairing T cell receptor sequences.
Unlike pairSEQ, which calculates p-values for every TCR alpha/beta overlap and compares
against a null distribution, BiGpairSEQ does not do any statistical calculations
directly. Instead, BiGpairSEQ creates a simple bipartite weighted graph representing the sample plate.
The distinct TCRA and TCRB sequences form the two sets of vertices. Every TCRA/TCRB pair that share a well
are connected by an edge, with the edge weight set to the number of wells in which both sequences appear.
(Sequences in all wells are filtered out prior to creating the graph, as there is no signal in their occupancy
The problem of pairing TCRA/TCRB sequences thus reduces to the "assignment problem" of finding a maximum weight
matching on a bipartite graph--the subset of vertex-disjoint edges whose weights sum to the maximum possible value.
USAGE
Released as an executable .jar file with interactive, command line UI
Usage: java -jar BiGpairSEQ_Sim.jar
Large cell sample or sample plate files may require large amounts of RAM.
It is often desirable to increase the JVM memory allocation with the -Xmx flag
For example, to run the program with 32 gigabytes of memory, use command:
java -Xmx32G -jar BiGpairSEQ_Sim.jar
Requires Java11 or higher (Openjdk-17 recommended)
pairSEQ citation:
Howie, B., Sherwood, A. M., et. al.
"High-throughput pairing of T cell receptor alpha and beta sequences."
Sci. Transl. Med. 7, 301ra131 (2015)
Simulation by Eugene Fischer, 2021-2022