index.Rmd

---
title: "Project Home"
site: workflowr::wflow_site
# output:
#   workflowr::wflow_html:
#     toc: false
output:
  bookdown::html_document2:
    toc: true
editor_options:
  chunk_output_type: console
  markdown: 
    wrap: 72
---

This is the website for the research project "Frequency-Aware Similarity
Calibration".

If you have cloned the project to a local computer this website is
rendered in the `docs` subdirectory of the project directory.

If you are using `workflowr` to publish the research website it will
also be rendered online to GitHub Pages.

This page acts as a table of contents for the website. There are links
to the web pages generated from the analysis notebooks and to the
rendered versions of manuscripts/documents/presentations.

------------------------------------------------------------------------

## [Project Workflow Status](m_00_status.html) {.unnumbered}

This notebook displays the computational status of the project, that is,
whether everything is up to date. Ironically, this is currently the only
notebook that must be run manually, so this notebook only displays the
status **when the notebook was last executed** and there is no
indication whether the project status has changed since then.

------------------------------------------------------------------------

# Overview documents {.unnumbered}

## [Proposal](proposal.html) {.unnumbered}

This notebook explains the central ideas behind the project.

## [Notes](notes.html) {.unnumbered}

This notebook is for keeping notes of any points that may be useful for
later project or manuscript development and which are not covered in the
analysis notebooks or at risk of getting lost in the notebooks.

## [Workflow management](workflow.html) {.unnumbered}

This project uses the [`targets`](https://wlandau.github.io/targets/)
and [`workflowr`](https://github.com/jdblischak/workflowr) packages for
managing the workflow of the project (making sure that the dependencies
between computational steps are satisfied). When this work was started
there were no easily found examples of using `targets` and `workflowr`
together. This notebook contains notes on the proposed workflow for
using `targets` and `workflowr`.

------------------------------------------------------------------------

# Publications {.unnumbered}

Links to rendered manuscripts and presentations will go here.

------------------------------------------------------------------------

# META Notebooks {.unnumbered}

These notebooks capture the analyses that were carried out to develop
the code of the core processing pipeline. They are organised as
side-chains to the core processing pipeline.

Typically, a meta notebook will analyse the data available at one stage
of the core pipeline, to guide the writing of the functions required to
get to the next stage of the core pipeline. These meta notebooks
generally conclude with the definition of a function that will be used
in the core pipeline.

There may be multiple notebooks all relating to different aspects of the
same stage of the core pipeline.

Sometimes the analyses are more diffuse - characterising the data in a
way that may be helpful for guiding the development of future core
stages, but not immediately resulting in the development of functions
for the core pipeline.

## Read, check, and standardise the entity data {.unnumbered}

Determine the initial data preparation of the imported entity records.

### [m_01_1\_read_raw_entity_data](m_01_1_read_raw_entity_data.html) {.unnumbered}

Read the raw entity data.

### [m_01_2\_exclusions](m_01_2_exclusions.html) {.unnumbered}

Apply the row exclusions (exclude test records and all records with
status other than ACTIVE & VERIFIED).

### [m_01_3\_drop_novar](m_01_3_drop_novar.html) {.unnumbered}

Drop variables with no variation.

### [m_01_4\_parse_dates](m_01_4_parse_dates.html) {.unnumbered}

Parse the date columns.

### [m_01_5\_check_admin](m_01_5_check_admin.html) {.unnumbered}

Check the administrative variables (data relating to the
administration of voter registration).

### [m_01_6_check_resid](m_01_6_check_resid.html) {.unnumbered}

Check the residence variables - residential address and phone number.

### [m_01_7_check_demog](m_01_7_check_demog.html) {.unnumbered}

Check the demographic variables - sex, age, and birth place.

### [m_01_8_check_name](m_01_8_check_name.html) {.unnumbered}

Check the name variables.



### [01-6 Clean variables](01-6_clean_vars.html) {.unnumbered}

Clean all the variables.

------------------------------------------------------------------------

## 02 Blocking variables {.unnumbered}

Examine the distributions of potential blocking variables.

### [02-1 Characterise blocking variables](02-1_char_block_vars.html) {.unnumbered}

Characterise the potential blocking variables and combinations of
variables.

### [02-2 Make blocking variables](02-2_mk_block_vars.html) {.unnumbered}

Construct the most promising potential combination blocking variables.

------------------------------------------------------------------------

## 03 Name frequency (equality) {.unnumbered}

Detailed examination of the distributions of name frequencies induced by
the string equality relation.

------------------------------------------------------------------------

## 04 Name frequency (similarity) {.unnumbered}

Detailed examination of the distributions of name frequencies induced by
a string similarity relation.

------------------------------------------------------------------------

## 05 Similarity calibration {.unnumbered}

Detailed examination of the calibration from similarity to probability
of identity match, both unconditionally and as a function of name
frequency.

------------------------------------------------------------------------

## 06 Compatibility models {.unnumbered}

Estimate multivariate compatibility models.