tripal_feature_admin.tpl.php 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. <h3>Tripal Feature Administrative Tools Quick Links:</h3>
  2. <ul>
  3. <li><a href="<?php print url("admin/tripal/tripal_feature/configuration") ?>">Feature Configuration</a></li>
  4. <li><a href="<?php print url("admin/tripal/tripal_feature/fasta_loader") ?>">Import a multi-FASTA file</a></li>
  5. <li><a href="<?php print url("admin/tripal/tripal_feature/gff3_load") ?>">Import a GFF3 file</a></li>
  6. <li><a href="<?php print url("admin/tripal/tripal_feature/sync") ?>">Sync Features</a></li>
  7. <li><a href="<?php print url("admin/tripal/tripal_feature/delete") ?>">Delete Features</a></li>
  8. </ul>
  9. <h3>Module Description:</h3>
  10. <p>The Tripal Feature module provides a new feature content type and interface for genomic features. </p>
  11. <h3>Setup Instructions:</h3>
  12. <p>After installation of the feature module. The following tasks should be performed</p>
  13. <ol>
  14. <li><p><b>Set Permissions</b>: By default only the site administrator account has access to create, edit, delete
  15. or administer features. Navigate to the <?php print l('permissions page', 'admin/user/permissions')?> and set the
  16. permissions under the 'tripal_feature' section as appropriate for your site. For a simple setup, allow anonymous
  17. users access to view content and create a special role for creating, editing and other administrative tasks.</p></li>
  18. <li><p><b>Loading of Ontologies</b>:
  19. Before loading genomic features you must also have several vocabularies loaded as well. Using the
  20. <?php print l('OGO loader','admin/tripal/tripal_cv/obo_loader')?> you should load the following
  21. ontologies:
  22. <ul>
  23. <li>Chado Feature Properties</li>
  24. <li>Relationship Ontology</li>
  25. <li>Sequence Ontology</li>
  26. <li>Gene Ontology (if loading GO terms for features)</li>
  27. </ul></p></li>
  28. <li><p><b>Create Organisms</b>: Before adding feature data you must already have the
  29. organisms loaded in the database. See the
  30. <?php print l('Tripal Organism Admin Page','admin/tripal/tripal_organism') ?> for
  31. instructions for adding and Syncing organisms.</p></li>
  32. <li><p><b>Create an Analysis</b>: Tripal requires that feature data loaded using the Tripal loaders
  33. be associated with an analyis. This provides a grouping for the feature data and can be used
  34. later to visualize data pipelines. Before loading feature data through the FASTA or GFF loaders
  35. you will need to <?php print l('create an analysis','node/add/chado-analysis') ?> for the data.</p></li>
  36. <li><p><b>Create Database Cross References</b>: If you would like to associate your feature data with an
  37. external database, check to ensure that the <?php print l('database already exists','admin/tripal/tripal_db/edit_db') ?>.
  38. If not you should <?php print l('add a new database record','admin/tripal/tripal_db/add_db') ?> before importing
  39. feature data. Be sure to set the URL and URL prefix for the database if you would like accessions (e.g. GO terms, NCBI
  40. accession) to link out to the external database.</p></li>
  41. <li><p><b>Data Import</b>: if you do not already have an existing Chado database with preloaded data
  42. then you will want
  43. to import data. You can do so using the Chado perl scripts that come with the normal
  44. <a href="http://gmod.org/wiki/Chado">distribution of Chado</a> or you can use
  45. the <a href="<?php print url('admin/tripal/tripal_feature/fasta_loader') ?>">FASTA loader</a> and
  46. <a href="<?php print url('admin/tripal/tripal_feature/gff3_load') ?>">GFF loader</a> provided here. If you
  47. created the Chado database using Tripal then you'll most likely want to use the Tripal loaders. If your data
  48. is not condusive for loading with these loaders and you can get your data into a tab-delimited format you can
  49. use Tripals' bulk loader.
  50. </p></li>
  51. <li><p><b>Sync Features</b>: After data is loaded you need to sync features. This process is what
  52. creates the pages for viewing online. Not all features need be synced. For instance, if you
  53. have loaded whole genome sequence with fully defined gene models with several features to define
  54. a gene and its products (e.g. gene, mRNA, CDS, 5\'UTR, 3\'UTR, etc) you probably only want to create
  55. pages for genes or genes and mRNA. You probably do not want a page for a 5\'UTR.
  56. Using the <a href="<?php print url('admin/tripal/tripal_feature/configuration/sync') ?>">Feature Sync page</a>
  57. you can sync (or create pages) for the desired feature types. </p></li>
  58. <li><p><b>Set Feature URL</b>: It is often convenient to have a simple URL for each feature page.
  59. For example, http://www.mygenomesite.org/[feature], where [feature] is a unique identifier for a feature page.
  60. With this, people can easily include links to feature pages of interest. Use the
  61. <a href="<?php print url('admin/tripal/tripal_feature/configuration') ?>">Feature Configuration page</a>
  62. to specify whether to use the feature name, unique name or internal ID as the [feature] portion of the
  63. URL. Select the one that will guarantee a unique identifier for feature pages.</p></li>
  64. </ol>
  65. </p>
  66. <h3>Features of this Module:</h3>
  67. <p>Aside from data loading and feature page setup (as described in the Setup section above),
  68. The Tripal feature module also provides the following functionality
  69. <ul>
  70. <li><p><b>Feature Browser:</b> The feature browser is a tabular list of features with links to their
  71. feature pages which appears on the organism
  72. page. It was created to provide a mechanism to allow site visitors to quickly
  73. accesss feature pages when they do not know what to search for. For sites with large numbers of features, this
  74. method for finding a specific pages is inadequate, but may still be included to aid new site
  75. visitors. This browser can be toggled on or off using the
  76. <a href="<?php print url('admin/tripal/tripal_feature/configuration') ?>">Feature Configuration page</a></p></li>
  77. <li><p><b>Feature Summary Report:</b> The feature summary report is a pie chart that indicates the types and quantities
  78. of feature types (Sequence Ontology terms) that are loaded in the database. It appears on the organism
  79. page. The summary can be toggled on or off using the
  80. <a href="<?php print url('admin/tripal/tripal_feature/configuration') ?>">Feature Configuration page</a></p></li>
  81. <li><p><b>Integration with Drupal Views</b>: <a href="http://drupal.org/project/views">Drupal Views</a> is
  82. a powerful tool that allows the site administrator to create lists or basic searching forms of Chado content.
  83. It provides a graphical interface within Drupal to allow the site admin to directly query the Chado database
  84. and create custom lists without PHP programming or customization of Tripal source code. Views can also
  85. be created to filter content that has not yet been synced with Druapl in order to protect access to non
  86. published data (only works if Chado was installed using Tripal). You can see a list of available pre-existing
  87. Views <a href="<?php print url('admin/build/views/') ?>">here</a>, as well as create your own. </p></li>
  88. <li><p><b>Simple Search Tool</b>: A <?php print l('simple search tool','chado/features') ?> is provided for
  89. finding features. This tool relies on Drupal Views. <a href="http://drupal.org/project/views">Drupal Views</a>
  90. which must be installed to see the search tool. Look for it in the navigation menu under the item
  91. "Search Biological Data". </p></li>
  92. <li><p><b>Delete Features</b>: You can <a href="<?php print url('admin/tripal/tripal_feature/delete') ?>">bulk delete features</a>
  93. by providing a list of feature names, or for a specific organism or for a specific feature type. Be sure you have
  94. a full backup of your site before performing a bulk delete.</p></li>
  95. </ul>
  96. </p>