# Heuristic Index-Based Record Linkage

## Documentation for package ‘joinery’ version 1.0.1

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

ambiguity_plot | Bar chart of candidates-per-record distribution (candidates only)
apply_filter | Apply a fitted filter to match features
approximate_date | Approximate dates by rounding to coarser time units
as_cologne | Encode text phonetically with the Cologne procedure
as_metaphone | Encode text phonetically with Metaphone
as_soundex | Encode text phonetically with Soundex
audit_strategy | Audit a Search Strategy Against Data
base_example | Base dataset for record linkage example
batch_map | Apply a function to DuckDB table batches
block_on_tokens | Block on a Column's Rare Tokens (region-free blocking)
block_size_plot | Bar chart of block sizes (requires block_by on strategy)
calibrate | Evaluate a fitted filter on labelled pairs
calibrate_matches | Calibrate matches end-to-end (features -> filter -> apply)
clear_embedding_cache | Clear the embedding reuse cache
cluster_size_plot | Bar chart of cluster-size distribution (duplicates only)
compare_stages | Compare Stages of a Multi-Stage Match
compute_embeddings | Compute Embeddings for Records
compute_rarity | Compute Token Rarity for Record Linkage
contribution_plot | Horizontal bar chart of per-column score contributions
coverage_plot | Bar chart of match coverage (base and/or target)
date_tokens | Extract date components as tokens
deduplicate_table | Deduplicate a Table
detect_duplicates | Detect Duplicate Records
drop_joinery_temp_tables | Drop all temporary DuckDB tables created by joinery
drop_numeric_tokens | Drop numeric (house-number) tokens from token lists
drop_short_tokens | Drop short tokens from token lists
duckdb_batch_plan | Create a Batch Plan for DuckDB Table Processing
Duckdb_Control | DuckDB Execution Control
duckdb_control | DuckDB Execution Control
Embedding_Strategy | Create an Embedding Strategy
embedding_strategy | Create an Embedding Strategy
Exact_Strategy | Define an Exact Matching Strategy
exact_strategy | Define an Exact Matching Strategy
explain_match | Explain a Single Match
export_for_labelling | Export a match sample to CSV for manual labelling
extract_initials | Extract initials from tokens
extract_unmatched | Extract Unmatched Records
filter_stopwords | Filter out stopwords from token lists
find_stopwords | Discover candidate stopwords from a prepared token table
fit_filter | Fit a false-positive filter on labelled match pairs
frontier_plot | Cost/recall frontier scatter for a strategy plan
fuzzy_tokens | Collapse near-duplicate tokens to a canonical form
generate_ngrams | Generate character n-grams from text
import_labels | Import a labelled CSV back into a feature/label table
inspect_tokens | Inspect Tokens for a Specific Column
joinery_recipe | Build a tidymodels recipe for calibration features
Match_Features | Build a per-pair feature table for calibration
match_features | Build a per-pair feature table for calibration
match_labels_example | Labelled candidate pairs for calibration examples
materialize_records | Materialize Records by ID
multi_stage_dedup | Staged Duplicate Detection (within one table)
multi_stage_search | Staged Search Across Tables or Sources
normalize_date | Normalize dates to ISO 8601 format (YYYY-MM-DD)
normalize_street | Normalize street names across languages
normalize_text | Normalize text for matching
norm_plot | Bar chart of embedding norm quantiles
numeric_tokens | Tokenize numeric fields, expanding ranges into individual numbers
plan_strategy | Plan a Search Strategy from Raw Inputs
prepare_search_data | Prepare Data for Record Linkage Search
rarity_distribution | Read the Token Rarity Distribution
rarity_histogram | Bar chart of median token rarity per column
recommendations | Recommendations from a Diagnostic Object
resolve_entities | Group Matched Pairs into Entities
sample_matches | Sample Matches for Review
score_density | Kernel density of the score distribution
score_embeddings | Score Embedding Pairs Using Cosine Similarity
score_histogram | Bar chart of the pre-binned score distribution
search_candidates | Search for Candidate Matches Between Tables
Search_Strategy | Define a Search Strategy for Record Linkage
search_strategy | Define a Search Strategy for Record Linkage
similarity_histogram | Histogram of sampled pairwise cosine similarities
smooth_rip | Configure rIP smoothing for a search strategy
smooth_rip_identity | Configure rIP smoothing for a search strategy
smooth_rip_log | Configure rIP smoothing for a search strategy
smooth_rip_offset | Configure rIP smoothing for a search strategy
smooth_rip_softmax | Configure rIP smoothing for a search strategy
stage_coverage_plot | Line plot of cumulative base coverage by stage
stage_score_plot | Grouped bar chart of score distributions by stage
street_stopwords | Multilingual Street-Name Stopwords
street_types | Multilingual Street-Type Normalization Dictionary
strip_vowels | Strip vowels from text (consonant skeleton)
summarise_matches | Summarise a Match Result
target_example | Target dataset for record linkage example
token_contribution_plot | Horizontal bar chart of per-token score contributions, coloured by column
token_frequency_plot | Bar chart of average tokens per record per column
token_shapes | Convert tokens to shape signatures
top_gap_density | Bar chart of top-1 vs top-2 score gap distribution (candidates only)
use_dictionary | Map tokens to canonical groups with a lookup table
vocab_overlap_plot | Bar chart of vocabulary overlap between base and target per column
word_tokens | Split text into word tokens
workshop_listings | Workshop external directory (target) for record linkage examples
workshop_panel | Multi-year workshop panel for cross-year linkage examples
workshop_register | Workshop guild register (base) for record linkage examples