Skip to content

Latest commit

 

History

History
141 lines (78 loc) · 3.82 KB

README.md

File metadata and controls

141 lines (78 loc) · 3.82 KB
Raw

tic codecov.io CRAN_Status_Badge Downloads Buy Me A Coffee Dependencies

KernelKnn


The KernelKnn package extends the simple k-nearest neighbors algorithm by incorporating numerous kernel functions and a variety of distance metrics. The package takes advantage of 'RcppArmadillo' to speed up the calculation of distances between observations. More details on the functionality of KernelKnn can be found in the blog-post and in the package Vignettes ( scroll down for information on how to use the docker image ).

To install the package from CRAN use,

install.packages("KernelKnn")

and to download the latest version from Github use the install_github function of the devtools package, 

devtools::install_github('mlampros/KernelKnn')

Use the following link to report bugs/issues,

https://github.com/mlampros/KernelKnn/issues


UPDATE 29-11-2019


Docker images of the KernelKnn package are available to download from my dockerhub account. The images come with Rstudio and the R-development version (latest) installed. The whole process was tested on Ubuntu 18.04. To pull & run the image do the following,


docker pull mlampros/kernelknn:rstudiodev

docker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 mlampros/kernelknn:rstudiodev

The user can also bind a home directory / folder to the image to use its files by specifying the -v command,


docker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 -v /home/YOUR_DIR:/home/rstudio/YOUR_DIR mlampros/kernelknn:rstudiodev

In the latter case you might have first give permission privileges for write access to YOUR_DIR directory (not necessarily) using,


chmod -R 777 /home/YOUR_DIR

The USER defaults to rstudio but you have to give your PASSWORD of preference (see https://rocker-project.org for more information).


Open your web-browser and depending where the docker image was build / run give,


1st. Option on your personal computer,


http://0.0.0.0:8787

2nd. Option on a cloud instance,


http://Public DNS:8787

to access the Rstudio console in order to give your username and password.


Citation:

If you use the KernelKnn R package in your paper or research please cite https://CRAN.R-project.org/package=KernelKnn/citation.html:


@Manual{,
  title = {{KernelKnn}: Kernel k Nearest Neighbors},
  author = {Lampros Mouselimis},
  year = {2021},
  note = {R package version 1.1.5},
  url = {https://CRAN.R-project.org/package=KernelKnn},
}