How to Contribute

This blog is open to contributions from everyone.

Olivier Binette https://olivierbinette.github.io (Duke University)
2022-11-29

The blog is open to contributions from anyone with interest in deterministic and probabilistic record linkage, entity resolution, data fusion, and statistical matching. See below for contribution instructions.

Some stats

Click to expand a full list of posts

Contribution Instructions

The blog is based on Distill for Rmarkdown, an Rmarkdown extension for scientific and technical writing on the web.

There are two ways to contribute to this blog:

  1. Contact Olivier Binette to get a blog post published from any source. This blog post can be written in text format, markdown format, rmarkdown format, or another format without complicated formatting.
  2. If you have familiarity with Rmarkdown and Github, you can follow the steps below to directly contribute to the blog.

System configuration

Make sure you have R and RStudio installed (you can separately install Pandoc instead of RStudio). You will also need to install the following packages in R:

install.packages(c("rmarkdown", "distill"))

Creating a new post

Follow these steps to create a new post:

  1. Fork the Github repository https://github.com/RecordLinkageIG/RecordLinkageIG.github.io
  2. Create a new RStudio project from version control, using the forked repository url. Alternatively, clone the forked repository and cd into it.
  3. Use the following R command to create a new post:
distill::create_post("My Post Title")
  1. This will create a new folder, named after the current date and provided post title, in the _posts directory. This folder contains an Rmarkdown document for you to edit.
  2. Edit the Rmarkdown document, referring to https://rstudio.github.io/distill/ for help with formatting and metadata options. You may also use previous posts as templates.
  3. Run the following R command to render your blog post as an html file:
rmarkdown::render_site()
  1. Commit, push, and create a pull request on https://github.com/RecordLinkageIG/RecordLinkageIG.github.io.

The pull request will be reviewed before your post is published on RLIG’s blog.

Submission requirements checklist

Make sure to review the following items before submitting your post.

title: "My Post Title"
description: |
  Description of my post.
preview: http://website.com/post-image
author:
  - name: Full Name
    url: url.com
    affiliation: State University
date: 2022-01-01
## About the Author(s) {.appendix}

The author works at State University. They are [...].

Code of Conduct

Please note that the RecordLinkageIG.github.io project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgements

This document uses code from https://github.com/shannonpileggi/pipinghotdata_distill.

Updated 2022-11-29 10:57:20