Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
iquasere committed May 19, 2020
1 parent 308f3b4 commit 3f03612
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ python upimapi.py -i aligned.blast --blast -o uniprotinfo.tsv
## Additional parameters

```
usage: upimapi.py [-h] -i INPUT [-o OUTPUT] [--excel]
usage: upimapi.py [-h] [-i INPUT] [-o OUTPUT] [--excel]
[-anncols ANNOTATION_COLUMNS] [-anndbs ANNOTATION_DATABASES]
[--blast] [--full-id] [--fasta] [--step STEP]
[--blast] [--full-id] [--fasta] [--step STEP] [-v]
UniProt Id Mapping through API
Expand All @@ -39,7 +39,8 @@ optional arguments:
-i INPUT, --input INPUT
Input filename - can be a list of IDs (one per line)
or a BLAST TSV file - if so, specify with the --blast
parameter
parameter. If no file is given as input, will read
from command line input
-o OUTPUT, --output OUTPUT
filename of output
--excel Will produce output in EXCEL format (default is TSV)
Expand All @@ -53,6 +54,16 @@ optional arguments:
--fasta Output will be generated in FASTA format
--step STEP How many IDs to submit per request to the API (default
is 1000)
-v, --version show program's version number and exit
A tool for retrieving information from UniProt.
```
```

## UPIMAPI is available through Bioconda!

To install UPIMAPI through bioconda and run it, simply pass these commands:
```
conda install -c bioconda upimapi
upimapi.py [arguments]
```
**NOTE:** there is no need to explicitly declare python use when installing with Bioconda!

0 comments on commit 3f03612

Please sign in to comment.