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

Add doc build_interactions

parent eb2ded38
......@@ -221,13 +221,38 @@ def build_interactions(filtered_macs, binary_interactions):
PS: genes and stimulis are frontier places
:return:
all_genes: All genes in all the solutions
all_stimuli: All stimulis in all the solutions
genes_interactions: Interactions between genes in the same solution
stimulis_interactions: Interactions between stimuli in the same solution
genes_stimuli_interactions: Interactions between genes and stimulis in the same solution
filtered_binary_interactions: Interactions between molecules of interest and frontier places that are not genes in trajectories
:param filtered_macs: All solutions related to the molecules of interest.
.. code-block:: python
(("frontier_1", "frontier_2", "frontier_3"),)
:type filtered_macs: <tuple <tuple <str>>>
:param binary_interactions: A dictionary of related frontier places.
.. code-block:: python
# For molecules of interest "A" and "B"
{"A": {
"frontier_1": 1,
"frontier_2": 1,
},
"B": {
"frontier_3": 1,
},
}
:type binary_interactions: <dict <str>: <Counter <str>: <int>>>
:return: Various Counters of binary interactions:
* all_genes: All genes in all the solutions
* all_stimuli: All stimulis in all the solutions
* genes_interactions: Interactions between genes in the same solution
* stimulis_interactions: Interactions between stimuli in the same solution
* genes_stimuli_interactions: Interactions between genes and stimulis in
the same solution
* filtered_binary_interactions: Counter interactions between molecules of
interest and frontier places that are not genes in trajectories
:rtype: <set>, <set>, <Counter>, <Counter>, <Counter>, <Counter>
"""
genes_stimuli_interactions = Counter()
......
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