https://github.com/pachadotdev/kendallknight

Efficient Implementation of Kendall's Correlation Coefficient Computation (i.e., O(n log n) complexity vs O(n^2) in base R)
https://github.com/pachadotdev/kendallknight

Last synced: about 1 year ago
JSON representation

Efficient Implementation of Kendall's Correlation Coefficient Computation (i.e., O(n log n) complexity vs O(n^2) in base R)

• Host: GitHub
• URL: https://github.com/pachadotdev/kendallknight
• Owner: pachadotdev
• License: apache-2.0
• Created: 2024-08-17T02:50:07.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-20T04:09:14.000Z (over 1 year ago)
• Last Synced: 2025-04-05T08:13:38.639Z (about 1 year ago)
• Language: R
• Homepage: https://pacha.dev/kendallknight
• Size: 946 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# kendallknight 

[![R-CMD-check](https://github.com/pachadotdev/kendallknight/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/pachadotdev/kendallknight/actions/workflows/R-CMD-check.yaml)

[![codecov](https://app.codecov.io/gh/pachadotdev/kendallknight/graph/badge.svg?token=kDP0pWmfRk)](https://app.codecov.io/gh/pachadotdev/kendallknight)

[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-donate-yellow.svg)](https://buymeacoffee.com/pacha)

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![CRAN status](https://www.r-pkg.org/badges/version/kendallknight)](https://CRAN.R-project.org/package=kendallknight)

## About

tldr; This package implements a different algorithm from the one implemented in

base R, and it reduces the complexity of the Kendall's correlation coefficient

from O(n^2) to O(n log n) resulting in a runtime of nano seconds or minutes

instead of minutes or hours. This package is written in C++ and uses cpp11 to

export the functions to R. See the vignette for the mathematical details.

If this software is useful to you, please consider donating on

[Buy Me A Coffee](https://buymeacoffee.com/pacha). All donations will

be used to continue improving `kendallknight`.

## Installation

You can install the released version of kendallknight from CRAN with:

``` r

install.packages("kendallknight")

```

You can install the development version of kendallknight like so:

``` r

remotes::install_github("pachadotdev/kendallknight")

```

## Examples

See the documentation and vignette: https://pacha.dev/kendallknight/.

## Code of Conduct

Please note that the kendallknight project is released with a

[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).

By contributing to this project, you agree to abide by its terms.