-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
nicer function signature for webblast()
- Loading branch information
Showing
3 changed files
with
11 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,20 @@ | ||
# WebBLAST | ||
|
||
API for Julia to call the BLAST Web API of NCBI and EBI. | ||
API for Julia to call the BLAST Web API of [NCBI](http://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD=Web&PAGE_TYPE=BlastHome). | ||
|
||
## Exported functions | ||
|
||
#### webblast | ||
|
||
```julia | ||
webblast(provider::String, sequence::String, threshold::Float64, cached=false) | ||
webblast(sequence::String, threshold::Float64=0.005, provider::Symbol=:ncbi, cached=false) | ||
``` | ||
|
||
Calls the the API of the given provider to search for a protein sequence and returns all hits within a E-Value threshold. | ||
|
||
**provider** A provider for a BLAST REST API, e.g. NCBI/EBI BLAST. Default "ncbi" (EBI to be implemented), "ncbi" searches for the sequence in the PDB. | ||
|
||
**sequence** The sequence to search for. | ||
|
||
**cached** Default ```false```, results can be cached, for example during development. | ||
**threshhold** threshold for the E-value of hits to be returned. Default is 0.005. | ||
|
||
**provider** A provider for a BLAST REST API, e.g. NCBI/EBI BLAST. Default ``:ncbi` (EBI to be implemented), "ncbi" searches for the sequence in the PDB. | ||
|
||
**cached** Default ```false```, results can be cached, for example during development. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters