R/data.R

In PIP-Technical-Team/wbpip: What the Package Does (One Line, Title Case)

#' ABC 2000 Income (microdata)
#'
#' A dataset containing synthetic microdata for 2000 individuals in the fake
#' country ABC for the year 2000. Income based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 2000 rows and 6 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   \item{gender}{Gender; male or female.}
#' }
#' @source Worldbank internal.
"md_ABC_2000_income"

#' ABC 2010 Income (microdata)
#'
#' A dataset containing synthetic microdata for 2000 individuals in the fake
#' country ABC for the year 2010. Income based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 2000 rows and 6 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   \item{gender}{Gender; male or female.}
#' }
#' @source Worldbank internal.
"md_ABC_2010_income"

#' DEF 2000 Consumption (microdata)
#'
#' A dataset containing synthetic microdata for 2000 individuals in the fake
#' country DEF for the year 2000. Consumption based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 2000 rows and 6 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   \item{gender}{Gender; male or female.}
#' }
#' @source Worldbank internal.
"md_DEF_2000_consumption"

#' GHI 2000 Consumption (microdata)
#'
#' A dataset containing synthetic microdata for 2000 individuals in the fake
#' country GHI for the year 2000. Consumption based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 2000 rows and 6 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   \item{gender}{Gender; male or female.}
#' }
#' @source Worldbank internal.
"md_GHI_2000_consumption"

#' GHI 2000 Income (microdata)
#'
#' A dataset containing synthetic microdata for 2000 individuals in the fake
#' country GHI for the year 2000. Income based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 2000 rows and 6 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   \item{gender}{Gender; male or female.}
#' }
#' @source Worldbank internal.
"md_GHI_2000_income"

#' GHI 2009 Income (group data)
#'
#' A dataset containing national group data for the fake country GHI for the
#' year 2009. Income based welfare values.
#'
#' Note that nothing in this dataset is real. It is only meant for testing and
#' example purposes.
#'
#' @format A data frame with 10 rows and 5 variables:
#' \describe{
#'   \item{country_code}{A fake three letter country code.}
#'   \item{survey_year}{The year of the survey.}
#'   \item{weight}{The weight of each indvidual's welfare value.}
#'   \item{welfare}{The welfare of each indvidual. Can represent either income or consumption.}
#'   \item{area}{Geographical location; urban or rural.}
#'   }
#' @source Worldbank internal.
"gd_GHI_2009_income"

#' A dataset containing fake group data distribution
#'
#'
#' @format A data frame with 10 rows and 2 variables:
#' \describe{
#'   \item{welfare}{A vector of welfate values}
#'   \item{weight}{A vector of population weight}
#'   }
#' @source Worldbank internal.
"grouped_data_ex1"

#' A dataset containing fake group data distribution
#'
#'
#' @format A data frame with 10 rows and 2 variables:
#' \describe{
#'   \item{welfare}{A vector of welfate values}
#'   \item{weight}{A vector of population weight}
#'   }
#' @source Worldbank internal.
"grouped_data_ex2"

#' A dataset containing fake group data distribution
#'
#'
#' @format A data frame with 10 rows and 2 variables:
#' \describe{
#'   \item{area}{A vector of area code (urban / rural)}
#'   \item{welfare}{A vector of welfate values}
#'   \item{weight}{A vector of population weight}
#'   }
#' @source Worldbank internal.
"grouped_data_ex3"