Repository files navigation

linkrep provides an easy-to-use and extensible architecture forgenerating linkage quality reports in R. It simplifies the process ofevaluating and reporting on the quality of data linkage.

This package aims to provide a comprehensive tool for data linkers toassess the quality of their linkage processes, while also helping dataproviders and researchers understand linkage errors and evaluatepotential biases.

Reports generated withlinkrep can be customized to fit your specificneeds:

• Add new elements: Include additional tables, figures, sections ordata as required

• Modify content: Customize written portions, including the Methodssection, to better reflect your specific linkage processes

• Personalize appearance: Adjust the report’s background, layout andstyles to tailor the report to your needs

Summary: Overview of the Methods section and results

How to Read This Report: Provides recommendations on how tointerpret the tables and figures to assess for potential biases

Linkage Rate Summary: Includes the linkage rate table whichstratifies linkage rates by sociodemographic factors and othercharacteristics

Linkage Algorithm Summary: If provided, includes tables and figuresdescribing the linkage algorithm and its quality

Background: Describes record linkage, how it’s performed, and itslimitations

Methods: Details the linkage process, including pre-processing andtechniques used

# install.packages("pak")pak::pak("CHIMB/linkrep")# You may need to install tinytex:# install.packages("tinytex")# tinytex::install_tinytex()

Navigate toReleases on the right-hand side of the GitHub page andselect the most recent release. Download theSource code (zip) file,then run the following code to complete installation:

# Select the unmodified package you downloaded from GitHub:pkg_path<- file.choose()devtools::install_local(pkg_path)# You may need to install tinytex:# install.packages("tinytex")# tinytex::install_tinytex()

For detailed instructions on formatting data for the report andcustomizing features, refer to theUserDocumentation

• Elizabeth Stoughton
• Barret A. Monchka