lissyrtools: Tools for LISSY Jobs

#' CPI and PPP deflators.
#'
#' A dataset containing the Consumer Price Index (CPI) and Purchasing Power Parity (PPP)
#' deflators that can be used to directly compare absolute monetary values across different
#' LIS and LWS datasets.
#'
#' @format A data frame with 7 variables:
#'
#' @source \url{https://www.lisdatacenter.org/resources/ppp-deflators/}
"deflators"


#' LIS and LWS datasets
#'
#' A data frame containing all the LIS and LWS datasets 
#' that can be used through LISSY, including some of their characteristics.
#'
#' @format A data frame with 7 variables:
"datasets"


#' Variable labels
#'
#' A data frame containing all LIS and LWS variables and its labels. 
#'
#' @format A data frame with 2 variables:
"data_vars_labels"

#' Variable notes
#'
#' A data frame indicating whether a given variable in one of the LIS/LWS datasets has a note or not for a specific year.
#'
#' @format A data frame with 6 variables:
"data_with_warnings"

#' Variable Status Data Frame
#'
#' A data frame that identifies whether a variable consists only of zeros or missing values for a given country and year.
#'
#' @format A data frame with 6 variables:
"missing_or_zero_vars_all"


#' Value Labels for Country-Specific Variables in LIS and LWS Datasets
#'
#' A data frame containing the categorized values of country-specific variables in the LIS and LWS datasets, organized by country and year.
#'
#' @format A data frame with 9 variables:
"value_label_c_data"

#' LIS Variables 
#'
#' A character vector containing the names of the variables available in LIS.
#'
#' @format A character vector of length 199.
"lis_variables"

#' LWS Variables 
#'
#' A character vector containing the names of the variables available in LWS.
#'
#' @format A character vector of length 336.
"lws_variables"


#'  Value Labels for Country-Specific Variables in LIS and LWS Datasets
#'
#' A data frame containing the categorized values of country-specific variables in the LIS and LWS datasets, organized by country and year.
#'
#' @format A data frame with 9 variables:
"value_label_c_data"

#' Sample Household-Level LIS Dataset - Italy 2014
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' it14_h_lis
#' }
"it14_h_lis"

#' Sample Individual-Level LIS Dataset - Italy 2014

#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' it14_p_lis
#' }
"it14_p_lis"

#' Sample Household-Level LIS Dataset - Italy 2016
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' it16_h_lis
#' }
"it16_h_lis"

#' Sample Individual-Level LIS Dataset - Italy 2016
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' it16_p_lis
#' }
"it16_p_lis"

#' Sample Household-Level LIS Dataset - Italy 2020
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' it20_h_lis
#' }
"it20_h_lis"

#' Sample Individual-Level LIS Dataset - Italy 2020
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' it20_p_lis
#' }
"it20_p_lis"

#' Sample Household-Level LIS Dataset - Mexico 2014
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' mx14_h_lis
#' }
"mx14_h_lis"

#' Sample Individual-Level LIS Dataset - Mexico 2014
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' mx14_p_lis
#' }
"mx14_p_lis"

#' Sample Household-Level LIS Dataset - Mexico 2016
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' mx16_h_lis
#' }
"mx16_h_lis"

#' Sample Individual-Level LIS Dataset - Mexico 2016
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' mx16_p_lis
#' }
"mx16_p_lis"

#' Sample Household-Level LIS Dataset - Mexico 2018
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' mx18_h_lis
#' }
"mx18_h_lis"

#' Sample Individual-Level LIS Dataset - Mexico 2018
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' mx18_p_lis
#' }
"mx18_p_lis"

#' Sample Household-Level LIS Dataset - US 2014
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' us14_h_lis
#' }
"us14_h_lis"

#' Sample Individual-Level LIS Dataset - US 2014
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' us14_p_lis
#' }
"us14_p_lis"

#' Sample Household-Level LIS Dataset - US 2016
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' us16_h_lis
#' }
"us16_h_lis"

#' Sample Individual-Level LIS Dataset - US 2016
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' us16_p_lis
#' }
"us16_p_lis"

#' Sample Household-Level LIS Dataset - US 2018
#'
#' @format Data frame with 1,000 rows and 112 columns.
#' @examples
#' \dontrun{
#' us18_h_lis
#' }
"us18_h_lis"

#' Sample Individual-Level LIS Dataset - US 2018
#'
#' @format Data frame with 1,000 rows and 97 columns.
#' @examples
#' \dontrun{
#' us18_p_lis
#' }
"us18_p_lis"

#' Sample Household-Level LWS Dataset - Italy 2014
#'
#' @format Data frame with 1,000 rows and 214 columns.
#' @examples
#' \dontrun{
#' it14_h_lws
#' }
"it14_h_lws"

#' Sample Individual-Level LWS Dataset - Italy 2014
#'
#' @format Data frame with 2,328 rows and 133 columns.
#' @examples
#' \dontrun{
#' it14_p_lws
#' }
"it14_p_lws"

#' Sample Household-Level LWS Dataset - Italy 2016
#'
#' @format Data frame with 1,000 rows and 214 columns.
#' @examples
#' \dontrun{
#' it16_h_lws
#' }
"it16_h_lws"

#' Sample Individual-Level LWS Dataset - Italy 2016
#'
#' @format Data frame with 2,215 rows and 133 columns.
#' @examples
#' \dontrun{
#' it16_p_lws
#' }
"it16_p_lws"

#' Sample Household-Level LWS Dataset - US 2016
#'
#' @format Data frame with 1,000 rows and 214 columns.
#' @examples
#' \dontrun{
#' us16_h_lws
#' }
"us16_h_lws"

#' Sample Individual-Level LWS Dataset - US 2016
#'
#' @format Data frame with 2,396 rows and 133 columns.
#' @examples
#' \dontrun{
#' us16_p_lws
#' }
"us16_p_lws"

#' Sample Household-Level LWS Dataset - US 2019
#'
#' @format Data frame with 1,000 rows and 214 columns.
#' @examples
#' \dontrun{
#' us19_h_lws
#' }
"us19_h_lws"

#' Sample Individual-Level LWS Dataset - US 2019
#'
#' @format Data frame with 2,273 rows and 133 columns.
#' @examples
#' \dontrun{
#' us19_p_lws
#' }
"us19_p_lws"