Skip to content

Commit 189156a

Browse files
committed
Update README
1 parent 0a61c34 commit 189156a

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,23 @@ Example
5454

5555
.. code-block:: python3
5656
57-
from pyard import ARD
57+
import pyard
5858
59-
# Initialize ARD object
60-
ard = ARD('3290')
59+
# Initialize ARD object with a version of IMGT HLA database
60+
ard = pyard.ARD(3290)
6161
62-
# Initialize with latest DB
63-
ard = ARD()
62+
# You can specify a data directory for temp files
63+
# ard = pyard.ARD('3290', data_dir='/tmp/py-ard')
6464
65-
#
65+
# Initialize with latest IMGT HLA database
66+
ard = pyard.ARD()
67+
68+
# You can choose to refresh the MAC code for previously used versions
69+
# ard = pyard.ARD(3290, refresh_mac=True)
70+
71+
#
6672
# Reduce Allele
67-
#
73+
#
6874
allele = "A*01:01:01"
6975
7076
ard.redux(allele, 'G')
@@ -76,13 +82,19 @@ Example
7682
ard.redux(allele, 'lgx')
7783
# >>> 'A*01:01'
7884
79-
#
85+
#
8086
# Reduce GL String
81-
#
82-
ard_gl = ard.redux_gl("A*01:01/A*01:01N+A*02:AB^B*07:02+B*07:AB", "G")
83-
# >>> ard_gl
87+
#
88+
ard.redux_gl("A*01:01/A*01:01N+A*02:AB^B*07:02+B*07:AB", "G")
8489
# 'B*07:02:01G+B*07:02:01G^A*01:01:01G+A*02:01:01G/A*02:02'
8590
91+
# py-ard can also reduce serology based typings
92+
ard.redux_gl('HLA-A*10^HLA-A*9', 'lg')
93+
# >>> ard_gl
94+
# 'HLA-A*24:19g/HLA-A*24:22g^HLA-A*26:01g/HLA-A*26:10g/HLA-A*26:15g/HLA-A*26:92g/HLA-A*66:01g/HLA-A*66:03g'
95+
96+
97+
8698
Command Line Tools
8799
------------------
88100

0 commit comments

Comments
 (0)