Skip to content

Commit

Permalink
polish README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kmayerb committed Jun 8, 2020
1 parent ddab7d6 commit 4de3114
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,18 @@ Sample TCRs according to VDJ gene usage frequency
pip install tcrsampler
```

Install default reference files:

```
python -c "from tcrsampler.setup_db import install_all_next_gen; install_all_next_gen(dry_run = False)"
```

### Example

```python

from tcrsampler.sampler import TCRsampler
t = TCRsampler(organism = 'human',db_file = 'alphabeta_db.tsv', ref_file= 'new_nextgen_chains_human_B.tsv')
t.make_ref_dict(max_sample = 3 )
assert isinstance(t.ref_dict[('TRBV1*01', 'TRBJ1-1*01')], list)
assert isinstance(t.sample([['TRBV1*01', 'TRBJ1-1*01',1]]), list)
t.make_ref_dict(max_sample = 100)
t.sample_ref_dict('TRBV1*01', 'TRBJ1-1*01',1)
t.sample([['TRBV1*01', 'TRBJ1-1*01',1], ['TRBV2*01', 'TRBJ1-1*01',1]])
```

0 comments on commit 4de3114

Please sign in to comment.