README.txt 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. What is Tripal?
  2. --------------
  3. Tripal is a collection of open-source freely available Drupal modules
  4. and is a member of the GMOD family of tools. Tripal serves as a web
  5. interface for the GMOD Chado database and is designed to allow anyone
  6. with genomic data to quickly create an online genomic database using
  7. community supported tools.
  8. Features
  9. --------------
  10. - a Chado installer
  11. - Data loaders for ontologies (controlled vocabularies), GFF files,
  12. and FASTA files
  13. - Generic Data Loader Modules allows for creation of custom loading
  14. templates
  15. - Drupal nodes (web pages) are automatically generated for organisms,
  16. genomic features, biological libraries, and stocks
  17. - Web pages can be enriched with analysis results from BLAST,
  18. KAAS/KEGG, InterProScan, and Gene Ontology (GO)
  19. - Views Integration allows for custom listings of data
  20. - Content pieces exposed as blocks allowing the use of Panels for
  21. custom layouts of Tripal Nodes
  22. Required Modules
  23. --------------
  24. - Drupal 6.x (work is currently underway for a 7.x compatible
  25. version)
  26. - Drupal Core Modules: Search and Path
  27. - Database containing GMOD Chado Schema (can be installed by the
  28. Tripal Core module)
  29. NOTE: A PostgreSQL database is required for installation of the
  30. Chado Schema
  31. Highly Recommended Modules
  32. - Views 2.x (Views 3.x compatible version already exists in 6.x-0.4-dev)
  33. - Views Data Export
  34. Installation
  35. --------------
  36. Please follow the online tutorial for installation instructions:
  37. http://www.gmod.org/wiki/Tripal_Tutorial_v1.1
  38. Customization
  39. --------------
  40. Tripal can be used “as is” but also allows for complete customization.
  41. PHP-based template files are provided for all data types to allow for
  42. precise customizations as required by the community. A well-developed
  43. Tripal API provides a uniform set of variables and functions for
  44. accessing any and all data within the Chado database.
  45. Future Work
  46. --------------
  47. Currently, Tripal only supports a large subset of the
  48. current Chado schema, but further development is underway. Meanwhile,
  49. others can use the Tripal API to develop their own extensions. Those
  50. extensions can in turn be made available for anyone to use. These
  51. custom extensions, the Tripal package, and access to support resource
  52. such as an active mailing list can be found on the Tripal website
  53. (http://tripal.sourceforge.net).
  54. For more information, see the recent publication:
  55. Stephen P. Ficklin, Lacey-Anne Sanderson, Chun-Huai Cheng, Margaret
  56. Staton, Taein Lee, Il-Hyung Cho, Sook Jung, Kirstin E Bett, Dorrie
  57. Main. Tripal: a construction Toolkit for Online Genome Databases.
  58. Database, Sept 2011. Vol 2011.