Commit f2b335ca authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

Update docstrings

parent 4eb80dc4
......@@ -911,34 +911,33 @@ def low_graph_info(model_file, centralities):
.. code-block:: javascript
{
'modelFile': '',
'modelName': '',
'events': 0,
'entities': 0,
'boundaries': 0,
'transitions': 0,
'graph_nodes': 0,
'graph_edges': 0,
'modelFile': 'string',
'modelName': 'string',
'events': int,
'entities': int,
'transitions': int,
'graph_nodes': int,
'graph_edges': int,
'centralities': {
'degree': {
'Ax': 0.0,
'Bx': 0.0
'entity_1': float,
'entity_2': float
},
'in_degree': {
'Ax': 0.0,
'Bx': 0.0
'entity_1': float,
'entity_2': float
},
'out_degree': {
'Ax': 0.0,
'Bx': 0.0
'entity_1': float,
'entity_2': float
},
'betweenness': {
'Ax': 0.0,
'Bx': 0.0
'entity_1': float,
'entity_2': float
},
'closeness': {
'Ax': 0.0,
'Bx': 0.0
'entity_1': float,
'entity_2': float
},
}
}
......@@ -1023,27 +1022,34 @@ def low_model_info(model_file,
.. code-block:: javascript
{
'modelFile': '',
'modelName': '',
'events': 0,
'entities': 0,
'boundaries': 0,
'transitions': 0,
'modelFile': 'string',
'modelName': 'string',
'events': int,
'entities': int,
'boundaries': int,
'transitions': int,
'entitiesLocations': {
'loc1': 0,
'loc2': 0
'cellular_compartment_a': int,
'cellular_compartment_b': int,
...
},
'entitiesTypes': {
'type1': 0,
'type2': 0
'biological_type_a': int,
'biological_type_b': int;
...
},
'entitiesData': {
'cadbiomName': '',
'uri': '',
'entityType': '',
'entityRef': '',
'location': '',
'names': []
'cadbiomName': 'string',
'uri': 'string',
'entityType': 'string',
'entityRef': 'string',
'location': 'string',
'names': ['string', ...],
'xrefs': {
'external_database_a': ['string', ...],
'external_database_b': ['string', ...],
...
}
}
}
......@@ -1159,19 +1165,19 @@ def model_graph(model_file, output_dir='./graphs/',
def model_info(model_file, output_dir='./',
all_entities=False, boundaries=False,
genes=False, default=True, **kwargs):
all_entities=False, boundaries=False,
genes=False, default=True, **kwargs):
"""Get quick and full informations about the model structure and places.
:param arg1: File for the '.bcx' model.
:param arg2: Output directory.
:param arg3: If True, data for all places of the model are returned
:param model_file: File for the '.bcx' model.
:param output_dir: Output directory.
:param all_entities: If True, data for all places of the model are returned
(optional).
:param arg4: If True, only data for the frontier places of the model
:param boundaries: If True, only data for the frontier places of the model
are returned (optional).
:param arg5: If True, only data for the genes of the model are returned
:param genes: If True, only data for the genes of the model are returned
(optional).
:param arg6: Display quick description of the model
:param default: Display quick description of the model
(Number of places, transitions, entities types, entities locations).
:keyword json: If True, make a JSON dump of results in output path(optional).
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment