# Assortment of header-only libraries

# Overview

assorthead vendors an assortment of header-only C++ libraries for use in Bioconductor packages. The use of a central repository avoids duplicate vendoring of libraries across multiple R packages, and enables better coordination of version updates across cohorts of interdependent C++ libraries. This package is minimalistic by design to ensure that downstream packages are not burdened with more transitive dependencies.

# Quick start

To use assorthead in a Bioconductor package, just add it to the `LinkingTo` field in the `DESCRIPTION`:

    LinkingTo: assorthead

The package C++ code can `#include` any of the available libraries, for example:

    #include "Eigen/Dense"
    #include "annoy/annoylib.h"
    #include "annoy/kissrandom.h"
    #include "tatami/tatami.hpp"

# Available libraries

Name | Version | Description
--- | --- | ---
tatami | v4.0.4 | C++ API for matrix representations
tatami_stats | v2.0.2 | Compute statistics from tatami matrices
tatami_mult | v0.1.3 | Multiplication of tatami matrices
tatami_chunked | v2.1.0 | tatami extension for chunked matrices
manticore | v1.0.3 | Execute arbitrary functions on the main thread
tatami_r | v2.0.5 | tatami extension for R matrices
tatami_hdf5 | v2.0.5 | tatami extension for HDF5 matrices
tatami_tiledb | v2.0.1 | tatami extension for TileDB matrices
eminem | v1.2.0 | tatami extension for TileDB matrices
byteme | v2.0.1 | C++ interfaces for reading/writing byte buffers
aarand | v1.1.0 | Lightweight random distribution functions
powerit | v2.0.1 | Power iterations
irlba | v3.0.1 | C++ port of IRLBA, based on the irlba R package
irlba_tatami | v0.1.0 | tatami wrappers for IRLBA
WeightedLowess | v2.1.4 | Lowess trend fitting with weights, à la `limma::weightedLowess`
kmeans | v4.0.6 | C++ port of `stats::kmeans` with various initialization methods
kmeans_tatami | v0.1.1 | tatami wrappers for k-means clustering
knncolle | v3.1.0 | C++ API for nearest-neighbor searches
knncolle_annoy | v0.3.0 | knncolle extension for Annoy
knncolle_hnsw | v0.3.0 | knncolle extension for HNSW
knncolle_kmknn | v0.2.0 | knncolle extension for HNSW
knncolle_tatami | v0.1.0 | knncolle extension for HNSW
kaori | v1.1.2 | Sequence alignment and counting for CRISPR guides
nenesub | v0.2.1 | Subsampling based on nearest neighbors
raiigraph | v1.2.0 | C++ wrappers around igraph data structures
scran_qc | v0.2.0 | Simple quality control for single-cell data
scran_norm | v0.2.2 | Scaling normalization for single-cell data
scran_variances | v0.2.2 | Variance modelling and feature selection for single-cell data
scran_pca | v0.3.2 | Principal components analysis for single-cell data
scran_graph_cluster | v0.3.0 | Graph-based clustering for single-cell data
scran_markers | v0.3.1 | Marker detection for groups of interest in single-cell data
scran_aggregate | v0.3.1 | Aggregating expression data for groups of cells
scran_blocks | v0.1.2 | Blocking utilities for all libscran libraries
annoy | v1.17.2 | Approximate nearest neighbors oh yeah
hnswlib | v0.8.0 | Hierarchical navigable small worlds for finding nearest neighbors
Eigen | 5.0.0 | C++ template library for linear algebra
gsdecon | v0.2.0 | Compute gene set scores via eigengenes
clrm1 | v0.2.0 | Compute gene set scores via eigengenes
mnncorrect | v3.0.0 | Batch correction with mutual nearest neighbors
qdtsne | v3.0.1 | Quick-and-dirty t-SNE in C++
umappp | v3.2.0 | C++ implementation of the UMAP algorithm
mumosa | v0.2.1 | Simple multi-modal analyses of single-cell data
phyper | v0.1.1 | Hypergeometric tail calculations for enrichment testing
subpar | v0.4.1 | Substitutable parallelization for C++ libraries
singlepp | v3.0.0 | Cell type annotation for single-cell expression data
millijson | v2.0.0 | Lightweight JSON parsing library
uzuki2 | v2.0.0 | Storing simple R lists inside HDF5 or JSON
ritsuko | v0.6.1 | Helper functions for ArtifactDB libraries
takane | v0.9.0 | ArtifactDB file validators
chihaya | v1.1.2 | A C++ validator for delayed array operations
sanisizer | v0.1.5 | Sanitize sizes to avoid integer overflow
topicks | v0.2.2 | Pick top genes for downstream analyses
factorize | v0.1.0 | Pick top genes for downstream analyses

# Using interfaces

The beachmat package contains the `initializeCpp()` function, which creates an external pointer to a `tatami::Matrix`. Similarly, the BiocNeighbors package can create external pointers to various knncolle objects via its `defineBuilder()` and `buildIndex()` functions. Downstream packages can use these pointers in their own C++ code by compiling against the relevant interfaces in assorthead. This means that downstream packages do not need to re-compile all of the relevant header libraries to get full functionality of beachmat, BiocNeighbors, etc. It also allows the C++ code of downstream packages to handle extensions to each framework, e.g., new matrix types in beachmat.hdf5. Check out each of the packages for more specific instructions on how to use its external pointers.

# Contributing

If you want to add new libraries or update existing versions, make a pull request with appropriate motifications in the `inst/fetch.R` file.