Difference between revisions of "BioNetGen"

From BioUML platform
Jump to: navigation, search
Line 8: Line 8:
 
Text changes are applied to the diagram on demand (after <i>"Apply BioNetGen"</i> button have been pressed).<br>
 
Text changes are applied to the diagram on demand (after <i>"Apply BioNetGen"</i> button have been pressed).<br>
 
Besides model representations synchronisation, also care is taken of preserving user diagram layout as well as BNG-text formatting (spaces, comments, etc.)<br>
 
Besides model representations synchronisation, also care is taken of preserving user diagram layout as well as BNG-text formatting (spaces, comments, etc.)<br>
 +
[[File:Bionetgen adding species.png|thumb|Scheme for species adding via BioNetGen]]
 +
[[File:Bionetgen adding reaction rule.png|thumb|Scheme for reaction adding via BioNetGen]]
 
<b>Please note:</b> text changes would be applied only after <i>"Apply BioNetGen"</i> button have been pressed. If diagram is changed before this button have been pressed, all changes in text will be lost!<br>
 
<b>Please note:</b> text changes would be applied only after <i>"Apply BioNetGen"</i> button have been pressed. If diagram is changed before this button have been pressed, all changes in text will be lost!<br>
 
It is allowed to remove connection with current version of BNG-text. To do it <i>"Remove connection"</i> button should be pressed. If this button is pressed text is recreated using diagram.<br>
 
It is allowed to remove connection with current version of BNG-text. To do it <i>"Remove connection"</i> button should be pressed. If this button is pressed text is recreated using diagram.<br>
<b>Note:</b> all text formatting and some of comments will be removed. Also BNG-attribute will be removed.<br>
+
<b>Note:</b> all text formatting and some of comments (which are not linked with existing nodes or variables) will be removed. Also BNG-attribute will be removed (new BNG-attribute will be added when the <i>"Apply BioNetGen"</i> button is pressed).<br>
<i>"Deploy diagram"</i> button being pressed deployed model is generated. Source diagram will be substituted by deployed diagram (it will not be saved without pressing of the save button, and will have "_deployed" suffix in its name).<br>
+
<i>"Deploy diagram"</i> button being pressed deployed model is generated. Deployed model corresponds to the model created by source BioNetGen using generate_network action. If there exists this action in the BNG-text BioUML use its parameterts otherwise default parameters are used. Source diagram will be substituted by deployed diagram (it will not be saved without pressing of the save button, and will have "_deployed" suffix in its name).<br>
 
<b>Note:</b> source diagram won't be changed and won't be replaced.<br>
 
<b>Note:</b> source diagram won't be changed and won't be replaced.<br>
[[File:Bionetgen adding species.png|thumb|Scheme for species adding via BioNetGen]]
 
[[File:Bionetgen adding reaction rule.png|thumb|Scheme for reaction adding via BioNetGen]]
 
  
 
==Features overview==
 
==Features overview==

Revision as of 16:47, 25 November 2013

Contents

BioNetGen plugin

Visual (SBGN) and text-based (BioNetGen) representations of the rule based model in BioUML

BioNetGen (BNG) plugin for BioUML 0.9.6 aims to combine two representations of the rule based model in BioUML:

  • visual representation as BioUML Type-diagram-icon.png diagram using special BNG-notation;
  • text-based representation using BioNetGen Language (BNGL)[1][2].

Plugin allows user to edit model both as BioUML Type-diagram-icon.png diagram and BNG-text. Visual representation being changed BNG-text is updated on the fly.
Text changes are applied to the diagram on demand (after "Apply BioNetGen" button have been pressed).
Besides model representations synchronisation, also care is taken of preserving user diagram layout as well as BNG-text formatting (spaces, comments, etc.)

Scheme for species adding via BioNetGen
Scheme for reaction adding via BioNetGen

Please note: text changes would be applied only after "Apply BioNetGen" button have been pressed. If diagram is changed before this button have been pressed, all changes in text will be lost!
It is allowed to remove connection with current version of BNG-text. To do it "Remove connection" button should be pressed. If this button is pressed text is recreated using diagram.
Note: all text formatting and some of comments (which are not linked with existing nodes or variables) will be removed. Also BNG-attribute will be removed (new BNG-attribute will be added when the "Apply BioNetGen" button is pressed).
"Deploy diagram" button being pressed deployed model is generated. Deployed model corresponds to the model created by source BioNetGen using generate_network action. If there exists this action in the BNG-text BioUML use its parameterts otherwise default parameters are used. Source diagram will be substituted by deployed diagram (it will not be saved without pressing of the save button, and will have "_deployed" suffix in its name).
Note: source diagram won't be changed and won't be replaced.

Features overview

Currently plugin is in alpha version, so some features of the BioNetGen aren't supported. Also we want to achieve full synchronisation between BioNetGen and plugin.

Features which are supported within plugin Features of the BioNetgen which are not supported in the alpha-version
  • Creating, removal and properties editing of species, molecules, molecule components, observables;
  • Creating, removal and properties editing of reactions with reactants and products;
  • Creating, removal and editing of variables' initial assignment (scalar rate equation);
  • Deploying diagram.
  • Molecule types (can be read from file, but there is no any check);
  • Functions;
  • Nf and stochastic simulations;
  • Labels usage for parameters, seed species, reaction rules and observables;
  • Expressions usage in observable definition.


Note: plugin also does not support changing of the species' initial value in the actions block.

References

  1. http://bionetgen.org
  2. BioNetGen diagram (file format)

See also

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox