R/datasets.R

In questionr: Functions to Make Surveys Processing Easier

#' Histoire de vie 2003
#'
#' Sample from 2000 people and 20 variables taken from the \emph{Histoire de
#' Vie} survey, produced in France in 2003 by INSEE.
#'
#' @docType data
#' @keywords datasets
#' @format A data frame with 2000 rows and 20 variables
#' @source \url{https://www.insee.fr/fr/statistiques/2532244}
#' @name hdv2003
NULL

#' 2012 French Census - French cities of more than 2000 inhabitants
#'
#' Sample from the 2012 national french census. It contains results for
#' every french city of more than 2000 inhabitants, and a small subset of
#' variables, both in population counts and proportions.
#'
#' @docType data
#' @keywords datasets
#' @format A data frame with 5170 rows and 60 variables
#' @source \url{https://www.insee.fr/fr/information/2008354}
#' @name rp2012
NULL

#' 2018 French Census - French cities of more than 2000 inhabitants
#'
#' Sample from the 2018 national french census. It contains results for every
#' french city of more than 2000 inhabitants, and a small subset of variables,
#' both in population counts and proportions.
#'
#' @docType data
#' @keywords datasets
#' @format A data frame with 5417 rows and 62 variables
#' @source \url{https://www.insee.fr/fr/information/5369871}
#' @name rp2018
NULL

#' A fertility survey
#'
#' Some fictive results from a fecondity survey, with French labels.
#'
#' @docType data
#' @keywords datasets
#' @format 3 data frames with labelled data (as if data would have been imported from SPSS with \pkg{haven}):
#'    \itemize{
#'      \item \code{menages} contains some information from the households selected for the survey;
#'      \item \code{femmes} contains the questionnaire administered to all 15-49 years old women
#'        living in the selected households;
#'      \item\code{enfants} contains one record for each child of the surveyed women.
#'    }
#'
#'    Data can be linked using the variables \code{id_menage} and \code{id_femme}.
#' @seealso \link{fertility} for an English version of this dataset.
#' @name fecondite
#' @examples
#' data(fecondite)
#' describe(menages)
#' describe(femmes)
#' describe(enfants)
NULL

#' A fertility survey - "menages" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing some information from the households selected
#' for the \link{fecondite} survey.
#' @name menages
NULL

#' A fertility survey - "femmes" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing the questionnaire administered to all
#' 15-49 years old women living in the selected households for the
#' \link{fecondite} survey.
#' @name femmes
NULL

#' A fertility survey - "enfants" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing one record for each child of the
#' surveyed women in the \link{fecondite} survey.
#' @name enfants
NULL


#' A fertility survey
#'
#' Some fictive results from a fecondity survey, with English labels.
#'
#' @docType data
#' @keywords datasets
#' @format 3 data frames with labelled data (as if data would have been imported from SPSS with \pkg{haven}):
#'    \itemize{
#'      \item \code{households} contains some information from the households selected for the survey;
#'      \item \code{women} contains the questionnaire administered to all 15-49 years old women
#'        living in the selected households;
#'      \item\code{children} contains one record for each child of the surveyed women.
#'    }
#'
#'    Data can be linked using the variables \code{id_household} and \code{id_woman}.
#' @seealso \link{fecondite} for an French version of this dataset.
#' @name fertility
#' @examples
#' data(fertility)
#' describe(households)
#' describe(women)
#' describe(children)
NULL

#' A fertility survey - "households" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing some information from the households
#' selected for the \link{fertility} survey.
#' @name households
NULL

#' A fertility survey - "women" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing the questionnaire administered to all
#' 15-49 years old women living in the selected households for the
#' \link{fertility} survey.
#' @name women
NULL

#' A fertility survey - "children" table
#'
#' Some fictive results from a fecondity survey.
#'
#' @docType data
#' @keywords datasets
#' @format a data frame containing one record for each child of the surveyed
#' women in the \link{fertility} survey.
#' @name children
NULL