pyagree API¶
-
pyagree.bennett_s(agreement_matrix)[source]¶ Evaluate Bennett, Alpert and Goldstein’s \(S\)
Compute the Bennett, Alpert and Goldstein’s S of agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – An \(n \times n\)-agreement matrix- Returns
The Bennett, Alpert and Goldstein’s \(S\) of agreement_matrix
- Return type
float- Raises
ValueError
-
pyagree.scott_pi(agreement_matrix)[source]¶ Evaluate Scott’s \(\pi\)
Compute the Scott’s Pi of agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – An \(n \times n\)-agreement matrix- Returns
The Scott’s \(\pi\) of agreement_matrix
- Return type
float- Raises
ValueError
-
pyagree.yule_y(agreement_matrix)[source]¶ Evaluate Yule’s \(Y\)
Compute the Yule’s Y of a \(2 \times 2\)-agreement matrix agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – A \(2 \times 2\)-agreement matrix- Returns
The Yule \(Y\) of agreement_matrix
- Return type
float- Raises
ValueError
-
pyagree.bangdiwala_b(agreement_matrix)[source]¶ Evaluate Bangdiwala’s \(B\)
Compute the Bangdiwala’s B of agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – An \(n \times n\)-agreement matrix- Returns
The Bangdiwala’s \(B\) of agreement_matrix
- Return type
float- Raises
ValueError
-
pyagree.cohen_kappa(agreement_matrix)[source]¶ Evaluate Cohen’s \(\kappa\)
Compute Cohen’s Kappa of agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – An \(n \times n\)-agreement matrix- Returns
The Cohen’s \(\kappa\) of agreement_matrix
- Return type
float- Raises
ValueError
-
pyagree.fleiss_kappa(classification_matrix)[source]¶ Evaluate Fleiss’s \(\kappa\)
Compute the Fleiss’s Kappa of a classification matrix classification_matrix.
- Parameters
classification_matrix (class:numpy.ndarray) – An \(N \times k\)-classification matrix
- Returns
The Fleiss’s \(\kappa\) of classification_matrix
- Return type
float- Raises
ValueError
-
pyagree.ia_c(agreement_matrix)[source]¶ Evaluate extension-by-continuity of Information Agreement
Compute the Extension-by-Continuity of IA (\(\text{IA}_{C}\)) of agreement_matrix.
- Parameters
agreement_matrix (
numpy.ndarray) – An agreement matrix- Returns
The extension-by-continuity of Information Agreement of agreement_matrix
- Return type
float- Raises
ValueError