|
2 | 2 |
|
3 | 3 | [](https://circleci.com/gh/ShawHahnLab/igseq/tree/dev) |
4 | 4 |
|
5 | | -**Work in Progress** |
6 | | - |
7 | 5 | A command-line tool for various common Ig-Seq tasks. These are heavily biased |
8 | 6 | toward the peculiarities of our protocol and for rhesus macaque antibody |
9 | 7 | sequences. Your mileage may vary. |
@@ -32,15 +30,17 @@ categories: early read processing tasks (demultiplex, trim, merge, etc.), and |
32 | 30 | various convenience tools (IgBLAST this against that, what database has the |
33 | 31 | closest V gene, etc.). |
34 | 32 |
|
| 33 | +### Read Processing |
| 34 | + |
35 | 35 | Read processing subcommands: |
36 | 36 |
|
37 | | - * getreads: Run [bcl2fastq] with an autogenerated sample sheet and some |
38 | | - customized settings to write Undetermined I1/R1/R2 fastq.gz files. |
39 | | - * demux: Demultiplex the I1/R1/R2 files according to per-sample barcodes |
| 37 | + * getreads: Run [bcl2fastq] with some customized settings to write |
| 38 | + Undetermined I1/R1/R2 fastq.gz files. |
| 39 | + * demux: Demultiplex the I1/R1/R2 files according to per-sample barcodes. |
40 | 40 | * phix: Map reads left unassigned post-demux to the PhiX genome for |
41 | | - troubleshooting |
42 | | - * trim: Run [cutadapt] to remove adapter/primer/barcode and low-quality |
43 | | - sequences on a per-sample basis |
| 41 | + troubleshooting. |
| 42 | + * trim: Run [Cutadapt] to remove adapter/primer/barcode and low-quality |
| 43 | + sequences on a per-sample basis. |
44 | 44 | * merge: Merge R1/R2 for each sample with [PEAR]. |
45 | 45 |
|
46 | 46 | Each step in the read processing produces a read counts summary CSV table |
@@ -103,6 +103,26 @@ The chain type is used to select the appropriate constant region primer: |
103 | 103 | See `igseq/data/examples/readproc.sh` for an example read processing workflow |
104 | 104 | from start to finish with a small set of reads. |
105 | 105 |
|
| 106 | +### Convenience Tools |
| 107 | + |
| 108 | +Various convenience subcommands: |
| 109 | + |
| 110 | + * igblast: Run IgBLAST with a streamlined interface. This can handle |
| 111 | + transparent database and auxiliary data file creation from rhesus or human |
| 112 | + germline V(D)J references. |
| 113 | + * summarize: Summarize attributes of antibody sequences in a table via |
| 114 | + IgBLAST. |
| 115 | + * vdj-gather: Gather VDJ sequences into one directory. |
| 116 | + * vdj-match: Find closest-matching germline VDJ sequences. |
| 117 | + * convert: Convert between FASTA/FASTQ/CSV/TSV formats. |
| 118 | + * identity: Calculate pairwise identities. |
| 119 | + * msa: Create multiple sequence alignments (using [MUSCLE]). |
| 120 | + * tree: Create and format phylogenetic trees (using [FastTree]). |
| 121 | + * list, show: list built-in reference data files, and show file contents with |
| 122 | + support for pretty-printing some common formats. |
| 123 | + |
106 | 124 | [bcl2fastq]: https://support.illumina.com/sequencing/sequencing_software/bcl2fastq-conversion-software.html |
107 | | -[cutadapt]: https://cutadapt.readthedocs.io |
108 | | -[PEAR]: https://cme.h-its.org/exelixis/web/software/pear/ |
| 125 | +[Cutadapt]: https://cutadapt.readthedocs.io |
| 126 | +[PEAR]: https://cme.h-its.org/exelixis/web/software/pear |
| 127 | +[MUSCLE]: https://drive5.com/muscle5 |
| 128 | +[FastTree]: http://www.microbesonline.org/fasttree |
0 commit comments