correlation
Calculate confidence intervals for correlation coefficients
Science Score: 10.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.9%) to scientific vocabulary
Keywords
Repository
Calculate confidence intervals for correlation coefficients
Basic Info
Statistics
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
correlation
Calculate confidence intervals for correlation coefficients, including Pearson's R, Kendall's tau, Spearman's rho, and customized correlation measures.
Methodology
Two approaches are offered to calculate the confidence intervals, one parametric approach based on normal approximation, and one non-parametric approach based on bootstrapping.
Parametric Approach
Say r_hat is the correlation we obtained, then with a transformation
z = ln((1+r)/(1-r))/2,
z would approximately follow a normal distribution,
with a mean equals to z(r_hat),
and a variance sigma^2 that equals to 1/(n-3), 0.437/(n-4), (1+r_hat^2/2)/(n-3) for the Pearson's r, Kendall's tau, and Spearman's rho, respectively (read Ref. [1, 2] for more details). n is the array length.
The (1-alpha) CI for r would be
(T(z_lower), T(z_upper))
where T is the inverse of the transformation mentioned earlier
T(x) = (exp(2x) - 1) / (exp(2x) + 1),
z_lower = z - z_(1-alpha/2) sigma,
z_upper = z + z_(1-alpha/2) sigma.
This normal approximation works when the absolute values of the Pearson's r, Kendall's tau, and Spearman's rho are less than 1, 0.8, and 0.95, respectively.
Nonparametric Approach
For the nonparametric approach, we simply adopt a naive bootstrap method.
- We sample a pair (x_i, y_i) with replacement from the original (paired) samples until we have a sample size that equals to n, and calculate a correlation coefficient from the new samples.
- Repeat this process for a large number of times (by default we use 5000),
- then we could obtain the (1-alpha) CI for r by taking the alpha/2 and (1-alpha/2) quantiles of the obtained correlation coefficients.
References
[1] Bonett, Douglas G., and Thomas A. Wright. "Sample size requirements for estimating Pearson, Kendall and Spearman correlations." Psychometrika 65, no. 1 (2000): 23-28.
[2] Bishara, Anthony J., and James B. Hittner. "Confidence intervals for correlations when data are not normal." Behavior research methods 49, no. 1 (2017): 294-309.
Installation:
pip install correlation
or
conda install -c wangxiangwen correlation
Example Usage:
```python
import correlation a, b = list(range(2000)), list(range(200, 0, -1)) * 10 correlation.corr(a, b, method='spearman_rho') (-0.0999987624920335, # correlation coefficient -0.14330929583811683, # lower endpoint of CI -0.056305939127336606, # upper endpoint of CI 7.446171861744971e-06) # p-value ```
Owner
- Name: Xiangwen Wang
- Login: XiangwenWang
- Kind: user
- Website: https://xiangwenwang.github.io
- Repositories: 5
- Profile: https://github.com/XiangwenWang
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Xiangwen Wang | w****w@v****u | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 0
- Average time to close issues: 1 day
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 2.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Federico2111 (2)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 333 last-month
- Total dependent packages: 0
- Total dependent repositories: 6
- Total versions: 1
- Total maintainers: 1
pypi.org: correlation
Calculate the confidence intervals of correlation coeficients
- Homepage: https://github.com/XiangwenWang/correlation
- Documentation: https://correlation.readthedocs.io/
- License: BSD 2-Clause License
-
Latest release: 1.0.0
published over 5 years ago
Rankings
Maintainers (1)
Dependencies
- numpy *
- scipy *