R/Data.R

In ctross/SkewCalc: Estimation Of Reproductive Skew

#' SkewCalc: Estimate reproductive skew using Multinomial Index
#'
#' Documentation here is bare-bones, but will be updated as needed.
#'
#' @name SkewCalc
#' @docType package
NULL

#' @title KipsigisMales
#' @name KipsigisMales
#' @docType data
#' @usage data(KipsigisMales)
#' @description Reproductive success and age for a census of Kipsigis men.
#' @format A data frame with 848 rows and 3 variables:
#' \describe{
#'   \item{\code{code}}{Personal ID code.}
#'   \item{\code{age}}{Age at death or last census.}
#'   \item{\code{rs}}{Reproductive success.}
#'}
#' @source Monique Borgerhoff Mulder
NULL

#' @title KipsigisFemales
#' @name KipsigisFemales
#' @docType data
#' @usage data(KipsigisFemales)
#' @description Reproductive success and age for a census of Kipsigis females.
#' @format A data frame with 1239 rows and 3 variables:
#' \describe{
#'   \item{\code{code}}{Personal ID code.}
#'   \item{\code{age}}{Age at death or last census.}
#'   \item{\code{rs}}{Reproductive success.}
#'}
#' @source Monique Borgerhoff Mulder
NULL

#' @title SukumaMales
#' @name SukumaMales
#' @docType data
#' @usage data(SukumaMales)
#' @description Reproductive success and age for a census of Sukuma men.
#' @format A data frame with 63 rows and 3 variables:
#' \describe{
#'   \item{\code{code}}{Personal ID code.}
#'   \item{\code{age}}{Age at death or last census.}
#'   \item{\code{rs}}{Reproductive success.}
#'}
#' @source Monique Borgerhoff Mulder
NULL

#' @title ColombiaRS
#' @name ColombiaRS
#' @docType data
#' @usage data(ColombiaRS)
#' @description Reproductive success, age, sex, and group for a sample of rural Colombians.
#' @format A data frame with 289 rows and 5 variables:
#' \describe{
#'   \item{\code{code}}{Personal ID code.}
#'   \item{\code{age}}{Age at death or last census.}
#'   \item{\code{rs}}{Reproductive success. Children born.}
#'   \item{\code{sex}}{Sex.}
#'   \item{\code{group}}{Afrocolombian or Embera.}
#'}
#' @source Cody T. Ross
NULL