Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kcha committed Mar 17, 2022
1 parent c101e84 commit 2cb0215
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ other tools such as [Sailfish](https://github.com/kingsfordgroup/sailfish) and

## Installation

QAPA consists of both Python (3.5+) and R scripts. A conda virtual environment
QAPA consists of both Python and R scripts. A conda virtual environment
can be created using the provided `environment.yml` file.

1. Clone the repo:
Expand All @@ -32,6 +32,9 @@ can be created using the provided `environment.yml` file.
mamba env create -f environment.yml
conda activate qapa

4. Test that `qapa` command is available

qapa --help
---

# Usage
Expand Down Expand Up @@ -170,6 +173,14 @@ Additional notes:
- 3' UTRs that contain introns will be skipped.
- Chromosome names that contain underscores are currently not supported and will be
skipped.
- Only genes with `Gene Type = 'protein_coding'` will be considered.

### Troubleshooting tips

- Use `--debug` option to produce more verbose logging messages
- Use `--save` and `--temp <dir_path>` to save intermediate files generated
by `qapa build`. `<dir_path>` should be a user accessible directory.


## 2) Extract 3′ UTR sequences (`fasta`)

Expand Down

0 comments on commit 2cb0215

Please sign in to comment.