discord

discord website Project Status: Active โ€“ The project has reached a stable, usable state and is being actively developed. R package version Package downloads
R-CMD-check Dev Main branch Codecov test coverage License

discord is an R package that provides functions for discordant kinship modeling and other sibling-based quasi-experimental designs. It includes functions for data preparation, regression analysis, and simulation of genetically-informed data. The package is designed to facilitate the implementation of discordant sibling designs in research, allowing for the control of shared familial confounding factors.

Visit the discord website for more information and detailed documentation. Below is a brief overview of the package, its features, and a roadmap to get you started.

Quick Start Guide

Step 1: Install the Package

# Install from CRAN
install.packages('discord')

# Or install development version from GitHub
# install.packages('devtools')
devtools::install_github('R-Computing-Lab/discord')

Step 2: Choose Your Starting Point

Your workflow depends on your data structure and experience level:

๐Ÿš€ New to discordant-kinship regression?

๐Ÿ“Š Have NLSY data or existing kinship links?

๐Ÿ”ง Need to build kinship links from scratch?

Step 3: Explore Advanced Topics

Once you understand the basics, explore specialized topics:

Package Features

Complete Vignette Roadmap

The package includes several vignettes organized by user needs. All vignettes can be accessed online or from the RStudio โ€œVignettesโ€ tab after package installation.

๐Ÿ“š Start Here: Core Workflows

These vignettes provide complete end-to-end examples and should be your first stop:

๐Ÿ”ง Data Preparation

๐Ÿ“Š Advanced Topics

External Reproducible Examples

Beyond the vignettes, you can find additional examples that fully reproduce analyses from our other publications (Garrison et al 2025, etc). These examples can be accessed via the following links and are presented in reverse chronological order:

Citation

If you use discord in your research or wish to refer to it, please cite the following package as well as the AMPPS paper:

To cite package 'discord' in publications use:

  Garrison S, Trattner J, Hwang Y (2026). _discord: Functions for
  Discordant Kinship Modeling_. doi:10.32614/CRAN.package.discord
  <https://doi.org/10.32614/CRAN.package.discord>, R package version
  1.3, <https://github.com/R-Computing-Lab/discord>.

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {discord: Functions for Discordant Kinship Modeling},
    author = {S. Mason Garrison and Jonathan Trattner and Yoo Ri Hwang},
    note = {R package version 1.3},
    url = {https://github.com/R-Computing-Lab/discord},
    year = {2026},
    doi = {10.32614/CRAN.package.discord},
  }

Contributing

Contributions to the discord project are welcome. For guidelines on how to contribute, please refer to the Contributing Guidelines. Issues and pull requests should be submitted on the GitHub repository. For support, please use the GitHub issues page.

License

discord is licensed under the GNU General Public License v3.0. For more details, see the LICENSE file.