Update README.md

wavefancy · Jun 25, 2019 · d4c14de · d4c14de
1 parent 2a71f2d
commit d4c14de
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
 # CircularPedigreeTree
+
+Please refer to `UMOD_PAPER/bash.sh` for how to replicate the figures in our paper. The script `UMOD_PAPER/src/PED2HTML.py` was used to convert a ped file to a html webpage with the circular pedigree rendered in a svg canvas. The python script needs `docopt` package, please install accordingly.
+
+If you find this script helpful for your work, please cite our work.