linkrep provides an easy-to-use and extensible architecture for
generating linkage quality reports in R. It simplifies the process of
evaluating and reporting on the quality of data linkage.
This package aims to provide a comprehensive tool for data linkage analysts to assess the quality of their linkage processes, while also helping data providers and researchers understand linkage errors and evaluate potential biases.
Reports generated with linkrep can be further customized to fit your
specific needs:
-
Add new elements: Include additional tables, figures, sections or data as required.
-
Modify content: Customize written portions, including the Methods section, to better reflect your specific linkage processes.
-
Personalize appearance: Adjust the report’s background, layout, styles, and references to tailor the report to your needs.
To install linkrep from GitHub, begin by installing and loading the
devtools package:
# install.packages("devtools")
library(devtools)Afterwards, you may install the automated data linkage package using
install_github():
devtools::install_github("CHIMB/linkrep")
# You may need to install tinytex:
# install.packages("tinytex")
# tinytex::install_tinytex()To install linkrep locally from GitHub, select the most recent release
from the right-hand tab on the GitHub repository page. Download the
Source code (zip) file, then move over to RStudio. You may then
run the code:
path_to_pkg <- file.choose() # Select the unmodified package you downloaded from GitHub.
devtools::install_local(path_to_pkg)
# You may need to install tinytex:
# install.packages("tinytex")
# tinytex::install_tinytex()Summary: Overview of the Methods section and results
How to Read This Report: Provides recommendations on how to interpret the tables and figures to assess for potential biases.
Linkage Rate Summary: Includes the linkage rate table which stratifies linkage rates by sociodemographic factors and other characteristics.
Linkage Algorithm Summary: If provided, includes tables and figures describing the linkage algorithm and its quality.
Performance Metrics: If provided, includes multiple performance metrics (0-100) listed in table, visualized using a radar chart.
Background: Describes record linkage, how it’s performed, and its limitations.
Methods: Details the linkage process, including pre-processing and techniques used.
Appendix: Algorithms that were considered for testing, along with their performance metrics, can be included at the end of the report.
For detailed instructions on formatting data for the report and customizing features, refer to the User Documentation
For examples of reports that can be generated using the linkrep
package, download and view the sample Final
Report
and Sensitivity Analysis
Report
which uses fake/synthetic data to better help showcase the elements that
make up each report.
