Skip to content
Snippets Groups Projects
Commit daa55d5a authored by Thomas  OBADIA's avatar Thomas OBADIA :speech_balloon:
Browse files

Correct incorrect reference to wide format instead of long format in...

Correct incorrect reference to wide format instead of long format in get_target_list_for_study() function documentation
parent d5c864ad
Branches
Tags
No related merge requests found
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
###################################################################### ######################################################################
#' Subset a total population to a target sample size stratified by age and sex. #' Subset a total population to a target sample size stratified by age and sex.
#' #'
#' @param x A data.frame containing the population inventory in a wide format. It should be the output of \code{INVENTORY_02_list_all_inventory_participants.R}. #' @param x A data.frame containing the population inventory in a long format. It should be the output of \code{INVENTORY_02_list_all_inventory_participants.R}.
#' @param n_target A (named) vector containing the target sample size in a cluster. If named, the names are expected to exactly match the country codes in the data.frame \code{x}. In case \code{n_target} is unnamed and/or has length 1, its value is recycled for all countries in \code{x}. #' @param n_target A (named) vector containing the target sample size in a cluster. If named, the names are expected to exactly match the country codes in the data.frame \code{x}. In case \code{n_target} is unnamed and/or has length 1, its value is recycled for all countries in \code{x}.
#' @param n_backup A (named) vector containing the number of individuals to include in a backup list that will come in addition to the primary list. If named, the names are expected to exactly match the country codes in the data.frame \code{x}. In case \code{n_backup} is unnamed and/or has length 1, its value is recycled for all countries in \code{x}. #' @param n_backup A (named) vector containing the number of individuals to include in a backup list that will come in addition to the primary list. If named, the names are expected to exactly match the country codes in the data.frame \code{x}. In case \code{n_backup} is unnamed and/or has length 1, its value is recycled for all countries in \code{x}.
#' @return A random sample subset from \code{x} where individuals are representative of those from the whole population in terms of age-(categorical)-and-sex-structure, within each country and cluster. #' @return A random sample subset from \code{x} where individuals are representative of those from the whole population in terms of age-(categorical)-and-sex-structure, within each country and cluster.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment