Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 3.19 KB

README.md

File metadata and controls

48 lines (39 loc) · 3.19 KB
Raw

Documentation Status DOI

Tripal Sequence Similarity Search (TSeq)

This module supports sequence similarity search on a Tripal website through a new dual application option. The Tripal module provides access to the speed increase available through Diamond for BLASTP/BLASTX style searches as well as traditional NCBI BLAST for BLASTN. Both applications are integrated into a single interface that provides file upload or copy/paste sequence support for the query and access to formatted databases for NCBI BLAST or Diamond. The target databases can be customized for the categories of whole genome, gene, protein, and transcriptome/unigene. The administration interface allows the admin user to set what pre-indexed databases are available (which show up in a dropdown menu). The module supports execution of the searches on a remote machine so that the search is not running directly on the limited resources typically associated with web servers.

Further Documentation

Extended documentation for this module lives here on Read The Docs

Requirements

Installation / Useful Pages & Info

  1. Visit /admin/tripal/extension/tseq/config to set up databases and other options
  2. Permission role 'administer diamond' created for site admins
  3. It is strongly recommended to use the Tripal Daemon to automate the tasks within for this module. Using the daemon ensures that new jobs are launched in a timely and consistent manner. It is especially important that this system be used to reduce any problems that may arise from file permission issues.
Path Description
TSeq Main Page
TSeq/submit Search submission page
TSeq/results/# Job results page (# is the Tripal Job ID)
admin/tripal/extension/tseq/config Module administration page

Status

  • Submit Form
  • Admin
  • Add/Delete/Modify Target Database List
  • Categories
  • Permissions
  • Basic Results Page
  • Advanced Results Page
  • Results list on User Profile "TSeq Analysis" tab
  • Database categorization
  • Check if existing database files are readable (for purposes of running against)
  • Email user when job has finished
  • Show the number of sequences in each target database
  • Better user input validation (biological)
  • Admin option: temp directory (--tmpdir)