Controlled Vocabulary API

  1. 2.x tripal_cv/api/tripal_cv.api.inc tripal_cv_api
  2. 1.x tripal_cv/api/tripal_cv.api.inc tripal_cv_api

This module provides a set of functions to simplify working with controlled vocabularies. Most of the API functions deal with retrieving terms or their parent vocabularies.

However, the API also supports generation of trees for browsing a vocabulary as well as generation of pie graphs for display of hierarchical counts of terms. Version 0.3b of Tripal provides a feature browser and a feature summary chart uses the API functions provided here. But in general charts and trees can be created for any controlled vocabulary.

Parent topics

File

tripal_cv/api/tripal_cv.api.inc, line 8
This module provides a set of functions to simplify working with controlled vocabularies.

Functions

Namesort descending Location Description
tripal_autocomplete_cvterm tripal_cv/api/tripal_cv.api.inc This function is intended to be used in autocomplete forms for searching for CV terms that begin with the provided string
tripal_get_cv tripal_cv/api/tripal_cv.api.inc Retrieves a chado controlled vocabulary variable
tripal_get_cvterm tripal_cv/api/tripal_cv.api.inc Retrieves a chado controlled vocabulary term variable
tripal_get_cvterm_select_options tripal_cv/api/tripal_cv.api.inc Create an options array to be used in a form element which provides a list of all chado cvterms
tripal_get_cv_select_options tripal_cv/api/tripal_cv.api.inc Create an options array to be used in a form element which provides a list of all chado cvs
tripal_insert_cv tripal_cv/api/tripal_cv.api.inc Adds a controlled vocabular to the CV table of Chado.
tripal_insert_cvterm tripal_cv/api/tripal_cv.api.inc Add's a controlled vocabulary term to the cvterm table.
tripal_insert_obo tripal_cv/api/tripal_cv.api.inc Add the OBO to the tripal_cv_obo table in the Drupal database.
tripal_submit_obo_job tripal_cv/api/tripal_cv.api.inc This function allows other modules to programatically submit an ontology for loading into Chado.
tripal_update_cvtermpath tripal_cv/api/tripal_cv.api.inc Updates the cvtermpath table of Chado for the specified CV.