Skip to content

Commit

Permalink
README edit
Browse files Browse the repository at this point in the history
  • Loading branch information
dpatrinos committed Jun 30, 2023
2 parents 9e956b2 + 1ec8333 commit b5957b2
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# PrimerDesigner
[![GNU General Public License 3.0](https://img.shields.io/badge/license-GPLv3-blue)](https://github.com/dpatrinos/PrimerDesigner/blob/main/LICENSE)

Expand All @@ -20,6 +19,8 @@ $ primerdesigner -h
### OUTPUT
# usage: primerdesigner [-h] (-c | -s) (-p | -m) [--chr CHR] [--start START] [--stop STOP] [--intron INTRON] [--sjPath SJPATH] [--left LEFT] [--right RIGHT]
# [--destination DESTINATION]
# usage: primerdesigner [-h] (-c | -s) (-p | -m) [--chr CHR] [--start START] [--stop STOP] [--intron INTRON] [--sjPath SJPATH] [--left LEFT] [--right RIGHT]
# [--destination DESTINATION]
#
# Create sequence for design of primers to span an exon-exon junction
#
Expand Down Expand Up @@ -52,6 +53,7 @@ $ primerdesigner -c -p --chr 1 --start 163310 --stop 163645
# Chromosome 1 sequence loaded
# 300bp sequence length constructed
# chr1_163310-163645.fasta created in /current/working/directory
# chr1_163310-163645.fasta created in /current/working/directory
```

### Generate sequences from an X-labeled splice junction dataset
Expand All @@ -61,10 +63,12 @@ $ primerdesigner -s -p --intron 1 --sjPath /path/to/sjdblist.csv

### OUTPUT
# Intron 1
# Intron 1
# NC_051336.1: 163310:163645
# Chromosome 1 sequence loaded
# 300bp sequence length constructed
# chr1_163310-163645.fasta created in /current/working/directory
# chr1_163310-163645.fasta created in /current/working/directory
```

The splice junction dataset needs to be a .csv or .tab file organized as follows:
Expand Down

0 comments on commit b5957b2

Please sign in to comment.