httkpop_direct_resample: Generate a virtual population by directly resampling the...
In httk: High-Throughput Toxicokinetics

View source: R/httkpop_direct_resample.R

httkpop_direct_resample

R Documentation

Generate a virtual population by directly resampling the NHANES data.

Description

Generate a virtual population by directly resampling the NHANES data.

Usage

httkpop_direct_resample(
  nsamp = NULL,
  gendernum = NULL,
  agelim_years = NULL,
  agelim_months = NULL,
  weight_category = c("Underweight", "Normal", "Overweight", "Obese"),
  gfr_category = c("Normal", "Kidney Disease", "Kidney Failure"),
  reths = c("Mexican American", "Other Hispanic", "Non-Hispanic White",
    "Non-Hispanic Black", "Other"),
  gfr_resid_var = TRUE,
  ckd_epi_race_coeff = FALSE,
  nhanes_mec_svy
)

Arguments

`nsamp`	The desired number of individuals in the virtual population. `nsamp` need not be provided if `gendernum` is provided.
`gendernum`	Optional: A named list giving the numbers of male and female individuals to include in the population, e.g. `list(Male=100, Female=100)`. Default is NULL, meaning both males and females are included, in their proportions in the NHANES data. If both `nsamp` and `gendernum` are provided, they must agree (i.e., `nsamp` must be the sum of `gendernum`).
`agelim_years`	Optional: A two-element numeric vector giving the minimum and maximum ages (in years) to include in the population. Default is c(0,79). If `agelim_years` is provided and `agelim_months` is not, `agelim_years` will override the default value of `agelim_months`.
`agelim_months`	Optional: A two-element numeric vector giving the minimum and maximum ages (in months) to include in the population. Default is c(0, 959), equivalent to the default `agelim_years`. If `agelim_months` is provided and `agelim_years` is not, agelim_months will override the default values of `agelim_years`.
`weight_category`	Optional: The weight categories to include in the population. Default is `c('Underweight', 'Normal', 'Overweight', 'Obese')`. User-supplied vector must contain one or more of these strings.
`gfr_category`	The kidney function categories to include in the population. Default is `c('Normal','Kidney Disease', 'Kidney Failure')` to include all kidney function levels.
`reths`	Optional: a character vector giving the races/ethnicities to include in the population. Default is `c('Mexican American','Other Hispanic','Non-Hispanic White','Non-Hispanic Black','Other')`, to include all races and ethnicities in their proportions in the NHANES data. User-supplied vector must contain one or more of these strings.
`gfr_resid_var`	Logical value indicating whether or not to include residual variability when generating GFR values. (Default is TRUE.)
`ckd_epi_race_coeff`	Logical value indicating whether or not to use the "race coefficient" from the CKD-EPI equation when estimating GFR values. (Default is FALSE.)
`nhanes_mec_svy`	`surveydesign` object created from `mecdt` using `svydesign` (this is done in `httkpop_generate`)