setup.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. Module Setup
  2. ============
  3. .. note::
  4. Remember you must set the ``$DRUPAL_HOME`` environment variable if you want to cut-and-paste the commands below. See :doc:`../../../prereqs/drupal_home`
  5. For this example we will be load functional data for our gene. To do this we will use the Blast, KEGG, and InterPro extension modules. However, these extension modules are not part of the "core" Tripal package but are available as separate extensions. Anyone may create extensions for Tripal. These extensions are useful for genomic data and therefore are included in this tutorial.
  6. To download these modules:
  7. ::
  8. cd $DRUPAL_HOME
  9. drush pm-download tripal_analysis_blast
  10. drush pm-download tripal_analysis_interpro
  11. Now, enable these extension modules:
  12. ::
  13. drush pm-enable tripal_analysis_blast
  14. drush pm-enable tripal_analysis_interpro
  15. For this example, we will use the following files which are available for downloading:
  16. - `Citrus_sinensis-orange1.1g015632m.g.iprscan.xml <http://www.gmod.org/mediawiki/images/0/0c/Citrus_sinensis-orange1.1g015632m.g.iprscan.xml>`_
  17. - `Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_uniprot_sprot.fasta.out <http://www.gmod.org/mediawiki/images/e/e8/Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_uniprot_sprot.fasta.out>`_
  18. - `Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_nr.out <http://www.gmod.org/mediawiki/images/2/24/Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_nr.out>`_
  19. Download these files to the ```$DRUPAL_HOME/sites/default/files``` directory. To do so quickly run these commands:
  20. ::
  21. cd $DRUPAL_HOME/sites/default/files
  22. wget http://www.gmod.org/mediawiki/images/0/0c/Citrus_sinensis-orange1.1g015632m.g.iprscan.xml
  23. wget http://www.gmod.org/mediawiki/images/e/e8/Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_uniprot_sprot.fasta.out
  24. wget http://www.gmod.org/mediawiki/images/2/24/Blastx_citrus_sinensis-orange1.1g015632m.g.fasta.0_vs_nr.out
  25. Each of these modules provides new fields for both the **gene** and **mRNA** content types. To add these new field to those content types, navigate to **Structure > Tripal Content Types** and click the **manage fields** link in the row for the **mRNA** content type. Click the link titled **Check for new fields**. After a few moments the page will refresh and you will be notified that new fields have been added.
  26. .. image:: setup1.png
  27. Next, we need to position the new field. Using the skills you learned in the :doc:`../../../building/content_types/configuring_page_display` Create two new **Tripal Panes** named:
  28. - Blast Results
  29. - Protein Domains
  30. Be sure to:
  31. - Place the new fields into each pane respectively
  32. - Move the Panes out of the **disabled** section.
  33. - Set the label for each field to **Hidden**.
  34. The following shows an example of this layout:
  35. .. image:: setup2.png
  36. The fields are now ready for display once data is added!
  37. .. note::
  38. If you want both the **Gene** and **mRNA** content type to have BLAST, InterPro and KEGG result fields you must repeat the steps above for both.
  39. .. note::
  40. Anytime you install a Tripal v3 extension module you should check for new fields, and then place those fields in the layout. Extension modules often will not do this for you because they do not assume you want these new fields.