Many data science problems reduce to operations on very tall, skinny matrices. However, sometimes these matrices can be so tall that they are difficult to work with, or do not even fit into main memory. One strategy to deal with such objects is to distribute their rows across several processors. To this end, we offer an 'S4' class for tall, skinny, distributed matrices, called the 'shaq'. We also provide many useful numerical methods and statistics operations for operating on these distributed objects. The naming is a bit "tongue-in-cheek", with the class a play on the fact that 'Shaquille' 'ONeal' ('Shaq') is very tall, and he starred in the film 'Kazaam'.

Basic matrix and statistics operations for very tall, narrow distributed matrices. For a more general distributed matrix framework, see pbdDMAT.
You can install the stable version from CRAN using the usual install.packages():
install.packages("kazaam")
The development version is maintained on GitHub, and can easily be installed by any of the packages that offer installations from GitHub:
### Pick your preference
devtools::install_github("RBigData/kazaam")
ghit::install_github("RBigData/kazaam")
remotes::install_github("RBigData/kazaam")
To simplify installation on cloud systems, we also have a Docker container available.
Our tall/skinny/distributed matrices are called shaq's which stands for Super Huge Analytics done Quickly. This of course has nothing at all to do with esteemed actor Shaquille O'Neal, who is very tall. And since the package is so easy to use, it sometimes looks like a magic trick. And "kazaam!" is something a magician might say. It is by mere coincidence that Shaquille O'Neal starred in a movie titled Kazaam.
Throughout the package, we make a few key assumptions:
comm.rank() (e.g., ranks 2 and 3, 20 and 21, 1000 and 1001, ...) should store adjacent pieces of the matrix.In order to get good performance, there are several other considerations:
m should be very large. If you only have a few hundred thousand rows (and few columns), you're probably better off with base R matrices.n should be very small. A shaq with 10,000 colums is pushing it.Because of these assumptions, we get a few distinct advantages over other, similar frameworks:
allreduce() of an n*n matrix. With even a few hundred MPI ranks, this is basically instantaneous. And since most of the work is local, operations should complete very quickly.2^31-1.Individual package methods are well-documented, both with example code and discussions of the total amount of communication required.
For complete example codes, see inst/batchtests. These are tests that are meant to be run in batch, generally with 2 or 4 MPI ranks. You can launch any one of them via:
mpirun -np 2 Rscript test_script.r
Finally, there is a comprehensive package vignette. If you installed the package from CRAN, you can view the vignette by entering:
vignette("kazaam", package="kazaam")
into your R session.