tripal_db_admin.tpl.php 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <h3>Tripal External Database Administrative Tools Quick Links</h3>
  2. <ul>
  3. <li><?php print l('Add an external database for cross-refernces.', 'admin/tripal/tripal_db/add_db') ?></li>
  4. <li><?php print l('Update or delete an external database.', 'admin/tripal/tripal_db/edit_db') ?></li>
  5. </ul><br>
  6. <h3>Module Description:</h3>
  7. <p>The Tripal DB Module provides the ability to add database cross reference to the
  8. data in your Tripal Website. Typically an external database (such as NCBI Genbank, Gene Ontology (GO),
  9. stocks database) contains a collection of objects (genomic sequences, vocabulary terms, stocks) that are
  10. uniquely identified using an accession number (or identifier). Data loaded into Tripal can be a
  11. associated with these objects in remote databases, and links can appear on pages allowing site visitors
  12. to view the associated objects on the remote database\'s website </p>
  13. <h3>Setup Instructions:</h3>
  14. <ol>
  15. <li><b>Set Permissions</b>: This module supports the Drupal user permissions interface for
  16. controlling administrative access for creating, editing and deleting database cross-reference resources.
  17. The default is that only the site administrator has these
  18. permissions. Best practice is to create <a href="<?php print url('admin/user/roles') ?>">a new role</a>
  19. for administrative tasks, (such as a webmaster role),
  20. and then <a href="<?php print url('admin/user/user') ?>">assign users to the role</a>. Finally,
  21. <a href="<?php print url('admin/user/permissions') ?>">assign the permission</a> titled "administer db cross-reference".
  22. to the new role.</li>
  23. <li><b>Adding or Editing an External Databases</b>. Many resources such as NCBI nr or ExPASy SwissProt (to name a few)
  24. come pre-loaded with Chado. However, you can add new entries or edit existing entries. Also, when loading
  25. ontologies (controlled vocabularies) using the Tripal CV module new databases are added automaticaly for
  26. each ontology. To enable linking of accession on a page to the page for that accession on the external
  27. database, simply add the URL and the URL prefix when adding or editing a database.</li>
  28. <li><b>Associate Data with Accessions</b>. The Tripal loaders (e.g. GFF, OBO) can associate accessions from
  29. remote data to genomic features and controlled vocabularies automatically. Use the loaders to load genomic
  30. features and controlled vocabularies respectively. Additionally, the bulk loader can be used to create
  31. loading templates for associating external database accessions.
  32. </li>
  33. </ol>
  34. <br><h3>Features of this Module:</h3>
  35. <ul>
  36. <li><b>Add an External Databases</b>:
  37. By entering the name and any additional details into the <a href="tripal_db/add_db">add database form</a> you register an external database with your website. This allows you to specify that a sequence feature or other data is also stored in an external database. This is escpecially useful if the external database may contain additional details not stored in yours. If the external database is online you can even provide a URL prefix which will automatically link any data in your website to theirs via a web link.</li>
  38. <li><b>Update or Delete and External Databases</b>
  39. To edit the details of an external database record or to delete an already existing external database, go to the <a href="tripal_db/edit_db">Update/Delete DBs form</a>. This will allow you to change details or enter new details.</li>
  40. </ul>