tripal_analysis_help.tpl.php 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <h3>Module Description:</h3>
  2. <p>The Tripal Analysis module provides a new analysis content type that is
  3. intended to be
  4. used when a more specialized analysis module does not exist. Because it is
  5. generic, it does not
  6. provide any visualization or data loading tools for analysis data.
  7. Specialized analysis modules,
  8. such as the Tripal Analysis Blast or Tripal Analysis KEGG modules provide
  9. loading and custom
  10. visualizations for the analysis results. These modules must be installed
  11. separately.
  12. </p>
  13. <h3>Setup Instructions:</h3>
  14. <p>After installation of the analysis module or any specialized analysis module.
  15. The following tasks should be performed</p>
  16. <ol>
  17. <li><p><b>Set Permissions</b>: By default only the site administrator
  18. account has access to create, edit, delete
  19. or administer analyses. Navigate to
  20. the <?php print l('permissions page', 'admin/user/permissions') ?>
  21. and set the
  22. permissions under the 'tripal_analysis' section as appropriate for
  23. your site. For a simple setup, allow anonymous
  24. users access to view content and create a special role for creating,
  25. editing and other administrative tasks.</p></li>
  26. <li><p><b>Create an Analysis</b>: An analysis should
  27. be <?php print l('created', 'node/add/chado-analysis') ?> before
  28. data is imported into chado. The generic analysis type should only
  29. be used when a more specialized analysis module
  30. (e.g. Tripal Analysis Blast module) does not already exists. All
  31. data imported into Chado should be associated with
  32. an analysis to help keep track of the source for data.</p></li>
  33. <li><p><b>Sync Analyses</b>: If you have analyses already stored in Chado
  34. and would like to create pages for them, then
  35. analyses can be synced using the
  36. <?php print l('analysis configuration page', 'admin/tripal/tripal_analysis/configuration') ?>
  37. . The process of 'syncing'
  38. automatically creates the pages as if you had created them using the
  39. step above.
  40. </p></li>
  41. </ol>
  42. <h3>Additional Features of this Module:</h3>
  43. <ul>
  44. <li><p><b>Simple Search Tool</b>:
  45. A <?php print l('simple search tool', 'chado/analyses') ?> is
  46. provided for
  47. finding analyses. This tool relies on Drupal Views. <a
  48. href="http://drupal.org/project/views">Drupal Views</a>
  49. which must be installed to see the search tool. Look for it in the
  50. navigation menu under the item
  51. "Search Data". </p></li>
  52. </ul>