Merge pull request #1 from EllaSchwab/main

Updated readme

README.md

@@ -1,6 +1,11 @@
-# reTCR
+# TCR Repertoire Analysis in R
 
-TCR Repertoire Analysis in R
+
+<img width="346" alt="reTCR_logo" src="https://github.com/EllaSchwab/reTCR/assets/118077332/2e96e990-14ad-4f52-97ff-1b0af108dc57">
+
+This package provides a streamlined resource for uniformly processed publicly available TCR-seq data from SRA with attention to known library preparation method and normalization by read number. The goal of reTCR is to provide users with a wealth of easy to access, end-to-end, uniformly processed data for exploratory analysis. 
+
+The raw sequencing data were processed with MiXCR using a specifc library preset for each study and further downsampled by read number allowing for comparison between samples. Normalization is crucial for separating biological signal from technical noise. Next, output from MiXCR is reformatted and input into [pyTCR](https://github.com/Mangul-Lab-USC/pyTCR) for downstream analysis. Users can browse attributes such as study metadata, clonotype count per sample, and several diveristy metrics. 
 
 > [!WARNING]
 > The package work is in progress.
@@ -172,3 +177,4 @@ reTCR::get_bottom_n_clonotypes(proj@data, 20, "cmv_status")
 # get hill numbers
 print(proj@hill)
 ```
+