BlastHTTP-1.4.0: Libary to interface with the NCBI blast REST interface

Safe HaskellNone
LanguageHaskell2010

Biobase.BLAST.HTTP

Description

Searches a provided sequence with the NCBI Blast REST service and returns a blast result in xml format as BlastReport.

The function blastHTTP takes the BlastHTTPQuery datatype as argument, which contains following elements:

  1. program: Selects the blast-program to be used for the query. Example values are blastn, blastp, blastx,.. If Nothing is used as argument the function will default to blastn. Type: Maybe String
  2. database: Selects the database to be queried against. Example values are refseq_genomic, nr, est,.. Please consider that the database must be chosen in accordance with the blastprogram. Default value: refseq_genomic. Type: Maybe String
  3. querySequences: nucleotides or protein sequences, depending on the blast program used. If no sequence is provided an exception as String will be produced. Type: [Fasta]
  4. optionalArguments: This argument is optional and will filter the result if provided. Type: Maybe String
  5. optionalWalltime: Optional walltime in mircroseconds. If specified, will terminate the query after reaching the timelimit and return Left. Type: Maybe Int

and returns Either a BlastReport (Right) on success or an exception as String (Left)

If you plan to submit more than 20 searches in one session, please look up the Usage Guidelines in the webservice information http://www.ncbi.nlm.nih.gov/BLAST/developer.shtml.

Synopsis

Documentation

blastHTTP :: BlastHTTPQuery -> IO (Either String BlastJSON2) Source #

Retrieve Blast results in Blast JSON2 format from the NCBI REST Blast interface The querySequence has to be provided, all other parameters are optional and can be set to Nothing optionalArguments is attached to the query as is .e.g: "&ALIGNMENTS=250"

blastTabularHTTP :: BlastHTTPQuery -> IO (Either String [BlastTabularResult]) Source #

Retrieve Blast results in Blast tabular format from the NCBI REST Blast interface The querySequence has to be provided, all other parameters are optional and can be set to Nothing optionalArguments is attached to the query as is .e.g: "&ALIGNMENTS=250"