README.md

In smasongarrison/discord: Functions for Discordant Kinship Modeling

discord

The goal of discord is to provide functions for discordant kinship modeling and other sibling-based quasi-experimental designs. It has highly customizable, efficient code for generating genetically-informed simulations and provides user-friendly functions to perform discordant-kinship regressions.

Installation

You can install the official version from CRAN

# Install/update discord with the release version from CRAN.
install.packages('discord')

You can also install/update discord with the development version of discord from GitHub with:

# If devtools is not installed, uncomment the line below.
# install.packages('devtools')
devtools::install_github('R-Computing-Lab/discord')

Citation

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

citation(package = "discord")
To cite package 'discord' in publications use:

  Garrison S, Trattner J (2021). _discord: Functions for Discordant
  Kinship Modeling_. R package version 1.1.0,
  <https://CRAN.R-project.org/package=discord>.

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {discord: Functions for Discordant Kinship Modeling},
    author = {S. Mason Garrison and Jonathan Trattner},
    year = {2021},
    note = {R package version 1.1.0},
    url = {https://CRAN.R-project.org/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.md file.

smasongarrison/discord documentation built on March 4, 2024, 12:55 p.m.