R/discord.R

In smasongarrison/discord: Functions for Discordant Kinship Modeling

#' @title Functions for Discordant Kinship Modeling.
#'
#' @description Utilities and functions for discordant kinship modeling (and
#'   other sibling-based quasi-experimental designs). Currently, the package
#'   contains data restructuring functions and functions for generating
#'   biometrically informed data for kin pairs.

#'
#' @docType package
#' @name discord-package
#' @aliases discord
#' @note
#'
#' The release version is available through \href{https://cran.r-project.org/package=discord}{CRAN} by
#' running \code{install.packages('discord')}.
#' The most recent development version is available through \href{https://github.com/R-Computing-Lab/discord}{GitHub} by
#' running
#' \code{devtools::install_github} \code{(repo = 'R-Computing-Lab/discord')}
#' (make sure \href{https://cran.r-project.org/package=devtools}{devtools} is already installed).
#' If you're having trouble with the package, please install the development version.  If this doesn't solve
#' your problem, please create a \href{https://github.com/R-Computing-Lab/discord/issues}{new issue}, or email Mason.
#'
#' @author
#'
#'  \href{https://www.smasongarrison.com/}{S. Mason Garrison} (Wake Forest University)
#'  \href{https://www.jdtrat.com/}{Jonathan Trattner}
#'  Cermet Ream
#'
#' Maintainer: S. Mason Garrison <garrissm@wfu.edu>
#' @references Garrison et al. (2019)
#' @keywords "behavior genetics"
#' @examples
#'
#' library(discord) # Load the package into the current R session.
#'
#' \dontrun{
#' # Install/update discord with the release version from CRAN.
#' install.packages("discord")
#'
#' # Install/update discord with the development version from GitHub
#' # install.packages('devtools') #Uncomment if `devtools` isn't installed already.
#' devtools::install_github("R-Computing-Lab/discord")
#' }
NULL