README.md

In rijpma/capelinker: Machine Learning-based Record Linkage for Historical South Africa

capelinker

capelinker is an R library facilitating a supervised machine learning approach to link families and individuals in historical South Africa. It provides helper functions and a number of pretrained models.

Installation

Capelinker is not on CRAN and needs to be installed from GitHub. The remotes package makes this easy.

library("remotes")
remotes::install_github("rijpma/capelinker")

Usage

1. Use preflight() to check whether the datasets are ready to link.
2. Make candidate links using candidates()
3. Calculate distances between candidate pairs using distcalc().
4. Train your own model or use pretrained models to predict links.

rijpma/capelinker documentation built on Nov. 7, 2024, 3:06 a.m.