SimBiology®

sbioaddtolibrary - Add to user-defined library

Syntax

sbioaddtolibrary (abstkineticlawObj)
sbioaddtolibrary (unitObj)
sbioaddtolibrary (unitprefixObj)

Arguments

Description

The function sbioaddtolibrary adds abstract kinetic laws, units, and unit prefixes to the user-defined library.

sbioaddtolibrary (abstkineticlawObj) adds the abstract kinetic law object (abstkineticlawObj) to the user-defined library.

sbioaddtolibrary (unitObj) adds the user-defined unit (unitObj) to the user-defined library.

sbioaddtolibrary (unitprefixObj) adds the user-defined unit prefix (unitprefixObj) to the user-defined library.

The sbioaddtolibrary function adds any abstract kinetic law, unit, or unit prefix to the root object's UserDefinedLibrary property. These library components become available automatically in future MATLAB^® sessions.

Use the abstract kinetic law objects in the built-in and user-defined library to construct a kinetic law object with the method addkineticlaw.

To get a component of the built-in and user-defined libraries, use the commands get(sbioroot, 'BuiltInLibrary') and (get(sbioroot, 'UserDefinedLibrary')).

To remove the library component from the user-defined library, use the function sbioremovefromlibrary. You cannot remove an abstract kinetic law object being used by a kinetic law object.

Examples

This example shows how to create an abstract kinetic law and add it to the user-defined library.

1. Create an abstract kinetic law.

   abstkineticlawObj = sbioabstractkineticlaw('ex_mylaw1', '(k1*s)/(k2+k1+s)');

2. Assign the parameter and species variables in the expression.

   set (abstkineticlawObj, 'SpeciesVariables', {'s'});
   set (abstkineticlawObj, 'ParameterVariables', {'k1', 'k2'});

3. Add the new abstract kinetic law to the user-defined library.

   sbioaddtolibrary(abstkineticlawObj);

   The function adds the abstract kinetic law to the user-defined library. You can verify this using sbiowhos.

   sbiowhos -kineticlaw -userdefined
   
   SimBiology Abstract Kinetic Law Array
   
   Index:    Library:       Name:     Expression:
   1         UserDefined    mylaw1    (k1*s)/(k2+k1+s)  

4. Use the new abstract kinetic law when defining a reaction's kinetic law.

   modelObj = sbiomodel('cell');
   reactionObj = addreaction(modelObj, 'A + B <-> B + C');
   kineticlawObj = addkineticlaw(reactionObj, 'ex_mylaw1');

   Note   Remember to specify the SpeciesVariableNames and the ParameterVariableNames in kineticlawObj to fully define the ReactionRate of the reaction.

See Also

addkineticlaw, sbioabstractkineticlaw, sbioremovefromlibrary, sbioroot, sbiounit, sbiounitprefix

sbioabstractkineticlaw

sbioconsmoiety