Main Content

rmproduct (reaction)

Remove species object from reaction object products

Syntax

rmproduct(reactionObj, SpeciesName)
rmproduct(reactionObj, speciesObj)

Arguments

reactionObjReaction object.
SpeciesNameName for a model object. Enter a species name or a cell array of species names.
speciesObjSpecies object. Enter a species object or an array of species objects.

Description

rmproduct(reactionObj, SpeciesName), in a reaction object (reactionObj), removes a species object with a specified name (SpeciesName) from the property Products, removes the species name from the property Reaction, and updates the property Stoichiometry to exclude the species coefficient.

rmproduct(reactionObj, speciesObj) removes a species object as described above using a MATLAB® variable for a species object.

The species object is not removed from the parent model property Species. If the species object is no longer used by any reaction, you can use the function delete to remove it from the parent object.

If one of the species specified does not exist as a product, a warning is returned.

Examples

Example 1

This example shows how to remove a product that was previously added to a reaction. You can remove the species object using the species name.

modelObj = sbiomodel('cell');
reactionObj = addreaction(modelObj, 'Phosphocreatine + ADP -> creatine + ATP + Pi');
rmproduct(reactionObj, 'Pi')

SimBiology Reaction Array

 Index:  Reaction:
  1      Phosphocreatine + ADP -> creatine + ATP

Example 2

Remove a species object using a model index to a species object.

modelObj = sbiomodel('cell');
reactionObj = addreaction(modelObj, 'A -> B + C');
reactionObj.Reaction   
 ans =
    A -> B + C
rmproduct(reactionObj, modelObj.Species(2));
reactionObj.Reaction   
  ans =
    A -> C

See Also

rmreactant

Introduced in R2006a