Skip to content

Commit

Permalink
fixing a few leftover docstring issues
Browse files Browse the repository at this point in the history
  • Loading branch information
kbonney committed Jan 18, 2024
1 parent 844b606 commit 124effb
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion pyrocs/biosciences/hill_diversity.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def hill_shannon(p: np.array) -> float:
The use of the geometric mean captures
the proportional difference from the mean of extreme values (rather than the absolute values).
The equation for the Hill-Simpson based on the formulation in
[Roswell et al., 2021](https://doi.org/10.1111/oik.07202)
:cite:p:`roswell_conceptual_2021`.
Hill Shannon (Perplexity):
Expand Down
2 changes: 1 addition & 1 deletion pyrocs/complex_systems/causal_complexity.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ def causal_complexity(A: np.ndarray):
(:math:`E`), nodes (:math:`N`), and connected components (:math:`P`)
:cite:p:`ebert_cyclomatic_2016`.
In contrast, feedback density captures the fraction of edges
(:math:`E_{loop}`) and nodes (:math:`N_loop`) that are involved in at least one
(:math:`E_{loop}`) and nodes (:math:`N_{loop}`) that are involved in at least one
feedback loop. As such, it reflects the potential for cyclic behaviors.
Jointly, the measure of causal complexity reflects the number of paths
through a system weighted to reflect those with feedback loops.
Expand Down
6 changes: 5 additions & 1 deletion pyrocs/complex_systems/grc.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@

def grc(A : np.ndarray, directed : bool):
"""
Global reaching centrality (GRC) measures the level of hierarchy within a network based on flow. The equation within the package follows the formulations from [Mones et al., 2012] (https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0033799), who quantify GRC as the difference between the maximum and the average value of the local reach centralities of nodes within the network:
Global reaching centrality (GRC) measures the level of hierarchy within a network based on flow.
The equation within the package follows the formulations from
:cite:p:`mones_hierarchy_2012`,
who quantify GRC as the difference between the maximum and the average value of the
local reach centralities of nodes within the network:
.. math::
Expand Down

0 comments on commit 124effb

Please sign in to comment.