NDEx CX API (indra.sources.ndex_cx_api
)¶
-
indra.sources.ndex_cx.ndex_cx_api.
process_cx
(cx_json, require_grounding=True)[source]¶ Process a CX JSON object into Statements.
Parameters: - cx_json (list) – CX JSON object.
- require_grounding (bool) – Whether network nodes lacking grounding information should be included among the extracted Statements (default is True).
Returns: Processor containing Statements.
Return type:
-
indra.sources.ndex_cx.ndex_cx_api.
process_cx_file
(file_name, require_grounding=True)[source]¶ Process a CX JSON file into Statements.
Parameters: - file_name (str) – Path to file containing CX JSON.
- require_grounding (bool) – Whether network nodes lacking grounding information should be included among the extracted Statements (default is True).
Returns: Processor containing Statements.
Return type:
-
indra.sources.ndex_cx.ndex_cx_api.
process_ndex_network
(network_id, username=None, password=None, require_grounding=True)[source]¶ Process an NDEx network into Statements.
Parameters: - network_id (str) – NDEx network ID.
- username (str) – NDEx username.
- password (str) – NDEx password.
- require_grounding (bool) – Whether network nodes lacking grounding information should be included among the extracted Statements (default is True).
Returns: Processor containing Statements. Returns None if there if the HTTP status code indicates an unsuccessful request.
Return type:
NDEx CX Processor (indra.sources.ndex_cx.processor
)¶
-
class
indra.sources.ndex_cx.processor.
NdexCxProcessor
(cx, require_grounding=True)[source]¶ The NdexCxProcessor extracts INDRA Statements from Cytoscape CX JSON.
Parameters: cx (list of dicts) – JSON content containing the Cytoscape network in CX format. -
statements
¶ list – A list of extracted INDRA Statements. Not all edges in the network may be converted into Statements.
-