No Description

Lacey-Anne Sanderson 9a44f8ee2d Merge pull request #80 from tripal/77-validateExtension 4 years ago
api 0ac8c03c09 Updated checking for file ending suffix. 4 years ago
docs 00fc20e0e6 Update custom_linkouts.rst 6 years ago
includes 0ac8c03c09 Updated checking for file ending suffix. 4 years ago
tests 68665b4839 Issue #44: Update tests to use actingAs(). 5 years ago
theme 799c726d9a Corrected iterative variables 5 years ago
.gitignore fd48ab2747 Ensure @file headers have documentation line. 5 years ago
.travis.yml e24e66a387 Increase wait for databases to start up. 4 years ago
LICENSE.txt f9982b2c1e Create LICENSE.txt 6 years ago
README.md d4395c207f Update README.md 5 years ago
blast_ui.info 8ac709eba2 Add version = 7.x-1.x-dev as version number in blast_ui.info. 5 years ago
blast_ui.install 734d301968 Removes all nodes of type 'Blast Database' when module is uninstalled 6 years ago
blast_ui.module 408cacb63f Switch cvitjs to use the libraries api. 6 years ago
composer.json 1b07673cc8 Set-up the testing environment using [TripalTestSuite v1.1](https://github.com/statonlab/TripalTestSuite). 6 years ago
composer.lock 68665b4839 Issue #44: Update tests to use actingAs(). 5 years ago
phpunit.xml 5e512c19db Add tests for blast node api. 5 years ago

README.md

Tripal Dependency Tripal Rating Gold Status GitHub release (latest by date)

Build Status Maintainability Test Coverage

INTRODUCTION

This module provides a basic interface to allow your users to utilize your server's NCBI BLAST+.

Specifically it provides blast program-specific forms (blastn, blastp, tblastn, blastx are supported). In the future, there will be a single form where you will be able to select either a nucleotide or a protein database to BLAST against regardless of the type of query and it will decide which BLAST program to use based on the combination of query/database type (ie: if you selected a protein database on the nucleotide BLAST form then blastx would be used).

BLAST submissions result in the creation of Tripal jobs which then need to run from the command-line. This ensures that long running BLASTs will not cause page time-outs but does add some management overhead and might result in longer waits for users depending on how often you have cron set to run Tripal jobs. You can alternatively use the Tripal Jobs Daemon to automate running of Tripal Jobs reducing user wait time and your own workload.

The BLAST results page is an expandable summary table with each hit being listed as a row in the table with query/hit/e-value information. The row can then be expanded to include additional information including the alignment. Download formats are allow users to download these results in the familiar tabular, GFF3 or HTML NCBI formats.

Installation

  1. Install NCBI BLAST+ on your server (Tested with 2.2.26+). There is a package available for Ubuntu to ease installation.
  2. Install this module as you would any Drupal module (ie: download, unpack in sites/all/modules and enable through http://[your site]/admin/modules)
  3. Create "Blast Database" nodes for each dataset you want to make available for your users to BLAST against. BLAST databases should first be created using the command-line makeblastdb program with the -parse_seqids flag.

It's recommended that you also install the Tripal Job Daemon to manage BLAST jobs and ensure they are run soon after being submitted by the user. Without this additional module, administrators will have to execute the tripal jobs either manually or through use of cron jobs.

Documentation Documentation Status

We have and extensive user guide and a developer guide available via readthedocs.

Comparison with other Modules

Tripal BLAST UITripal BLAST Analysis
Provides an interface to execute BLASTsYesNo
Display BLAST Results to usersAfter BLAST submissionOn associated feature pages
Load BLAST Results into ChadoNoYes

NOTE: These modules will be combined into a single download available here in the not so distant future. You will still have the flexibility to enable either one or the other or both.

Future Development

  • The ability to blast against 2+ datasets at the same time
  • Ability to Email user when BLAST is done
  • Automatic cleaning up of BLAST job files after 1 week (make time frame configurable)