Tripal v1.0 (6.x-1.0)
Analysis Module API

Functions

 tripal_analysis_get_property ($analysis_id, $property)
 tripal_analysis_insert_property ($analysis_id, $property, $value, $update_if_present=0)
 tripal_analysis_update_property ($analysis_id, $property, $value, $insert_if_missing=0)
 tripal_analysis_delete_property ($analysis_id, $property)
 tripal_analysis_get_node ($analysis_id)

Function Documentation

tripal_analysis_delete_property ( analysis_id,
property 
)

Delete a given property

Parameters:
$analysis_idThe analysis_id of the property to delete
$propertyThe cvterm name of the property to delete

Note: The property will be identified using the unique combination of the $analysis_id and $property and then it will be deleted

Returns:
True of success, False otherwise

Definition at line 118 of file tripal_analysis.api.inc.

                                                                  {
  return tripal_core_delete_property('analysis', $analysis_id, $property, 'tripal');
}
tripal_analysis_get_node ( analysis_id)

Retreives the node of a sync'ed analysis

Parameters:
$analysis_idThe analysis_id of the property to delete
Returns:
node of analysis on success, null otherwise

Definition at line 133 of file tripal_analysis.api.inc.

                                                {
  $sql = "SELECT *
           FROM chado_analysis CA
              INNER JOIN node N on CA.nid = N.nid
           WHERE analysis_id = %d";
  $node = db_fetch_object(db_query($sql, $analysis_id));
  return $node;
}
tripal_analysis_get_property ( analysis_id,
property 
)

Retrieve properties of a given type for a given analysis

Parameters:
$analysis_idThe analysis_id of the properties you would like to retrieve
$propertyThe cvterm name of the properties to retrieve
Returns:
An analysis chado variable with the specified properties expanded

Definition at line 53 of file tripal_analysis.api.inc.

                                                               {
  return tripal_core_get_property('analysis', $analysis_id, $property, 'tripal');
}
tripal_analysis_insert_property ( analysis_id,
property,
value,
update_if_present = 0 
)

Insert a given property

Parameters:
$analysis_idThe analysis_id of the property to insert
$propertyThe cvterm name of the property to insert
$valueThe value of the property to insert
$update_if_presentA boolean indicated whether to update the record if it's already present
Returns:
True of success, False otherwise

Definition at line 74 of file tripal_analysis.api.inc.

                                                                                                  {
    return tripal_core_insert_property('analysis', $analysis_id, $property, 'tripal', $value, $update_if_present);
}
tripal_analysis_update_property ( analysis_id,
property,
value,
insert_if_missing = 0 
)

Update a given property

Parameters:
$analysis_idThe analysis_id of the property to update
$propertyThe cvterm name of the property to update
$valueThe value of the property to update
$insert_if_missingA boolean indicated whether to insert the record if it's absent

Note: The property will be identified using the unique combination of the $analysis_id and $property and then it will be updated with the supplied value

Returns:
True of success, False otherwise

Definition at line 98 of file tripal_analysis.api.inc.

                                                                                                  {
  return tripal_core_update_property('analysis', $analysis_id, $property, 'tripal', $value, $insert_if_missing);
}
 All Classes Files Functions Variables