search

shaunpwilkinson / kmer

K-mer Counting for Biological Sequence Analysis
26 stars 6 forks source link

readme

kmer

CRAN_Status_Badge Build Status DOI codecov Project Status: Active - The project has reached a stable, usable state and is being actively developed. License: GPL v3 ORCiD

K-mer counting and clustering for biological sequence analysis

kmer is an R package for rapidly computing distance matrices and clustering large sequence datasets using fast alignment-free k-mer counting and recursive k-means partitioning.

Installation

To download kmer from CRAN and load the package, run

install.packages("kmer")
library("kmer")

To download the development version from GitHub, first ensure a C/C++ compliler is available and the devtools R package is installed. Linux users will generally have a compiler installed by default; however Windows users may need to download Rtools and Mac OSX users will need Xcode (note that these are not R packages). To download and install devtools, run 

install.packages("devtools")

The kmer package can then be installed and loaded by running

devtools::install_github("shaunpwilkinson/kmer") 
library("kmer")

Help

An overview of the package and its functions can be found by running

?kmer

To view the tutorial, you can either run

vignette("kmer-vignette")

or access it directly from CRAN.

If you experience a problem using this package please feel free to raise it as an issue on GitHub. Any feedback is appreciated.

Acknowledgements

This software was developed at Victoria University of Wellington with funding from a Rutherford Foundation Postdoctoral Research Fellowship award from the Royal Society of New Zealand.