CV Module 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

@file Controlled Vocabulary 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

Tripal API
Provides an application programming interface (API) for Tripal

File

tripal_cv/api/tripal_cv.api.inc, line 3
Controlled Vocabulary API

Functions

Namesort descending Location Description
tripal_cv_add_cv tripal_cv/api/tripal_cv.api.inc Adds a controlled vocabular to the CV table of Chado.
tripal_cv_add_cvterm tripal_cv/api/tripal_cv.api.inc Add's a CV term to the cvterm table. If the parent CV does not exist then that too is added to the CV table. If the cvterm is a relationship term then the $is_relationship argument should be set. The function will try to first find the…
tripal_cv_add_obo_ref tripal_cv/api/tripal_cv.api.inc Add the obo to the tripal_cv_obo table in the Drupal database
tripal_cv_cvterm_name_autocomplete 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_cv_get_custom_tables tripal_cv/api/tripal_cv.api.inc This function defines the custom tables that will be created in the chado schema.
tripal_cv_get_cv tripal_cv/api/tripal_cv.api.inc Purpose: To retrieve a chado controlled vocabulary object
tripal_cv_get_cvterm_by_id tripal_cv/api/tripal_cv.api.inc Retrieve a chado cvterm object with a given name
tripal_cv_get_cvterm_by_name tripal_cv/api/tripal_cv.api.inc Retrieve a chado cvterm object with a given name
tripal_cv_get_cvterm_by_synonym tripal_cv/api/tripal_cv.api.inc Retrieve a chado cvterm object with a given name
tripal_cv_get_cvterm_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_cv_get_cv_by_id tripal_cv/api/tripal_cv.api.inc Retrieve the cv object for the specified CV id
tripal_cv_get_cv_by_name tripal_cv/api/tripal_cv.api.inc Retrieve a cv given the cv name
tripal_cv_get_cv_id tripal_cv/api/tripal_cv.api.inc Retrieve the cv id for the specified CV by name
tripal_cv_get_cv_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_cv_get_term_children tripal_cv/includes/trees.inc Generates SON needed for jsTree -expanding a term to view children
tripal_cv_update_cvtermpath tripal_cv/api/tripal_cv.api.inc Updates the cvtermpath table of Chado for the specified CV.