tripal_analysis_help.tpl.php 2.3 KB

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