Skip to content

Commit

Permalink
[scripts] Add additional README info in sites
Browse files Browse the repository at this point in the history
  • Loading branch information
tanghaibao committed Oct 10, 2017
1 parent 084f14e commit ff86eb6
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions sites/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,21 @@ Initiate a template by the following command:
```bash
python tredprepare.py
```

The scripts does a questionaired similar to the following:

```bash
Enter the locus name [HD]: PIEZO1
Sequence motif [CAG]: TCC
Number of motifs in reference [19]: 8
Chromosomal start location (1-based) [chr4:3074877]: chr16:88733965
Enter the FASTA path [/mnt/ref/hg38.upper.fa]:
AGCCCCTCGTCCCTGGAG|tcctcctcctcctcctcctcctcc|TGCTGCTGCTGCTGATGC

Template json file is written to `sites/PIEZO1.json`
Please manually fill in the remaining details
```

The user will then need to modify the generated ``sites/*.json`` to fill in
additional information - most critically, the ``cutoff_risk`` and
``inheritance``. Please see the include ``PIEZO1.json`` for a sample JSON file.

0 comments on commit ff86eb6

Please sign in to comment.